jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix prelude regression refs #16238: include prelude doesn't interfere with nim doc (#17111)

Browse source 
* fix bug1 from #16238 nim doc now works with include prelude

* fix for windows

* fixup
This commit is contained in:
Timothee Cour 2021-02-22 02:10:34 -08:00 • committed by GitHub
commit ef5303114c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

28
lib/pure/prelude.nim
View file

@ -7,18 +7,22 @@
# distribution, for details about the copyright.
#
## This is an include file that simply imports common modules for your
## convenience:
##
## .. code-block:: nim
## include std/prelude
##
## Same as:
##
## .. code-block:: nim
## import std/[os, strutils, times, parseutils, hashes, tables, sets, sequtils, parseopt]
when defined(nimdoc) and isMainModule:
from std/compileSettings import nil
when compileSettings.querySetting(compileSettings.SingleValueSetting.projectFull) == currentSourcePath:
## This is an include file that simply imports common modules for your convenience.
runnableExamples:
include std/prelude
# same as:
# import std/[os, strutils, times, parseutils, hashes, tables, sets, sequtils, parseopt]
let x = 1
assert "foo $# $#" % [$x, "bar"] == "foo 1 bar"
assert toSeq(1..3) == @[1, 2, 3]
when not defined(js) or defined(nodejs):
assert getCurrentDir().len > 0
assert ($now()).startsWith "20"
# xxx deduplicate with prelude.rst
# xxx `nim doc -b:js -d:nodejs --doccmd:-d:nodejs lib/pure/prelude.nim` fails for some reason
# specific to `nim doc`, but the code otherwise works with nodejs.
import std/[os, strutils, times, parseutils, hashes, tables, sets, sequtils, parseopt]