diff options
| author | n5m <72841454+n5m@users.noreply.github.com> | 2021-02-02 08:44:21 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-02 09:44:21 +0100 |
| commit | f87b9866af0ddc435f9873bd89cd973009b27c6e (patch) | |
| tree | 7bc731fe20beb6c530ad4af20b3ca07c99eb3a8b /lib/std/compilesettings.nim | |
| parent | 4b2054a7bf2443f01db80aaac9d5de6f42e555cd (diff) | |
| download | Nim-f87b9866af0ddc435f9873bd89cd973009b27c6e.tar.gz | |
link compile-time options together in docs (#16879)
* link similar compiler option proc together * fixup links * fix formatting and links * example formatting * drop declared * link to compilesettings * only link define pragmas once * drop another declared * backlink to compileOptions from compilesettings * remove newline
Diffstat (limited to 'lib/std/compilesettings.nim')
| -rw-r--r-- | lib/std/compilesettings.nim | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/lib/std/compilesettings.nim b/lib/std/compilesettings.nim index b9b13175d..5f3da011e 100644 --- a/lib/std/compilesettings.nim +++ b/lib/std/compilesettings.nim @@ -43,14 +43,26 @@ type proc querySetting*(setting: SingleValueSetting): string {. compileTime, noSideEffect.} = discard - ## Can be used to get a string compile-time option. Example: + ## Can be used to get a string compile-time option. + ## + ## See also: + ## * `compileOption <system.html#compileOption,string>`_ for `on|off` options + ## * `compileOption <system.html#compileOption,string,string>`_ for enum options + ## + ## Example: ## ## .. code-block:: Nim ## const nimcache = querySetting(SingleValueSetting.nimcacheDir) proc querySettingSeq*(setting: MultipleValueSetting): seq[string] {. compileTime, noSideEffect.} = discard - ## Can be used to get a multi-string compile-time option. Example: + ## Can be used to get a multi-string compile-time option. + ## + ## See also: + ## * `compileOption <system.html#compileOption,string>`_ for `on|off` options + ## * `compileOption <system.html#compileOption,string,string>`_ for enum options + ## + ## Example: ## ## .. code-block:: Nim ## const nimblePaths = compileSettingSeq(MultipleValueSetting.nimblePaths) |