summary refs log tree commit diff stats
path: root/lib/std
diff options
context:
space:
mode:
authorflywind <xzsflywind@gmail.com>2021-03-12 14:33:13 +0800
committerGitHub <noreply@github.com>2021-03-12 07:33:13 +0100
commit5dff66b35ad256ba2ea159f977ba25e3c28801f6 (patch)
tree741049cf9dc6a31d3697499883cfc79efcad4b6b /lib/std
parentbe49505719a20cc23c957e3e1eba127f68afebda (diff)
downloadNim-5dff66b35ad256ba2ea159f977ba25e3c28801f6.tar.gz
fix wrong examples (#17350)
* fix wrong examples

* Update lib/std/compilesettings.nim

* Update lib/std/compilesettings.nim

Co-authored-by: Timothee Cour <timothee.cour2@gmail.com>
Diffstat (limited to 'lib/std')
-rw-r--r--lib/std/compilesettings.nim17
1 files changed, 6 insertions, 11 deletions
diff --git a/lib/std/compilesettings.nim b/lib/std/compilesettings.nim
index 7058e55a5..725b68acd 100644
--- a/lib/std/compilesettings.nim
+++ b/lib/std/compilesettings.nim
@@ -43,27 +43,22 @@ type
     clibs             ## libraries passed to the C/C++ compiler
 
 proc querySetting*(setting: SingleValueSetting): string {.
-  compileTime, noSideEffect.} = discard
+  compileTime, noSideEffect.} =
   ## 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)
+  runnableExamples:
+    const nimcache = querySetting(SingleValueSetting.nimcacheDir)
 
 proc querySettingSeq*(setting: MultipleValueSetting): seq[string] {.
-  compileTime, noSideEffect.} = discard
+  compileTime, noSideEffect.} =
   ## 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)
+  runnableExamples:
+    const nimblePaths = querySettingSeq(MultipleValueSetting.nimblePaths)