From f87b9866af0ddc435f9873bd89cd973009b27c6e Mon Sep 17 00:00:00 2001 From: n5m <72841454+n5m@users.noreply.github.com> Date: Tue, 2 Feb 2021 08:44:21 +0000 Subject: 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 --- lib/std/compilesettings.nim | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) (limited to 'lib/std/compilesettings.nim') 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 `_ for `on|off` options + ## * `compileOption `_ 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 `_ for `on|off` options + ## * `compileOption `_ for enum options + ## + ## Example: ## ## .. code-block:: Nim ## const nimblePaths = compileSettingSeq(MultipleValueSetting.nimblePaths) -- cgit 1.4.1-2-gfad0