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

Hyperlinks slurp related docstrings in system module.

Browse source
This commit is contained in:
Grzegorz Adam Hankiewicz 2014-07-19 14:48:30 +02:00
commit c0aaff028b
1 changed files with 14 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

24
lib/system.nim
View file

@ -2232,9 +2232,12 @@ when not defined(JS): #and not defined(NimrodVM):
## current file position is not at the beginning of the file. ## current file position is not at the beginning of the file.
proc readFile*(filename: string): TaintedString {.tags: [FReadIO], gcsafe.} proc readFile*(filename: string): TaintedString {.tags: [FReadIO], gcsafe.}
## Opens a file named `filename` for reading. Then calls `readAll` ## Opens a file named `filename` for reading.
## and closes the file afterwards. Returns the string. ##
## Raises an IO exception in case of an error. ## Then calls `readAll <#readAll>`_ and closes the file afterwards.
## Returns the string. Raises an IO exception in case of an error. If
## you need to call this inside a compile time macro you can use
## `staticRead <#staticRead>`_.
proc writeFile*(filename, content: string) {.tags: [FWriteIO], gcsafe.} proc writeFile*(filename, content: string) {.tags: [FWriteIO], gcsafe.}
## Opens a file named `filename` for writing. Then writes the ## Opens a file named `filename` for writing. Then writes the
@ -2726,19 +2729,20 @@ proc `[]=`*[T](s: var seq[T], x: TSlice[int], b: openArray[T]) =
spliceImpl(s, a, L, b) spliceImpl(s, a, L, b)
proc slurp*(filename: string): string {.magic: "Slurp".} proc slurp*(filename: string): string {.magic: "Slurp".}
## This is an alias for ``staticRead``. ## This is an alias for `staticRead <#staticRead>`_.
proc staticRead*(filename: string): string {.magic: "Slurp".} proc staticRead*(filename: string): string {.magic: "Slurp".}
## Compile-time ``readFile`` proc for easy `resource`:idx: embedding: ## Compile-time `readFile <#readFile>`_ proc for easy `resource`:idx:
## embedding:
## ##
## .. code-block:: nimrod ## .. code-block:: nimrod
## const myResource = staticRead"mydatafile.bin" ## const myResource = staticRead"mydatafile.bin"
## ##
## ``slurp`` is an alias for ``staticRead``. ## `slurp <#slurp>`_ is an alias for ``staticRead``.
proc gorge*(command: string, input = ""): string {. proc gorge*(command: string, input = ""): string {.
magic: "StaticExec".} = discard magic: "StaticExec".} = discard
## This is an alias for ``staticExec``. ## This is an alias for `staticExec <#staticExec>`_.
proc staticExec*(command: string, input = ""): string {. proc staticExec*(command: string, input = ""): string {.
magic: "StaticExec".} = discard magic: "StaticExec".} = discard
@ -2750,9 +2754,9 @@ proc staticExec*(command: string, input = ""): string {.
## const buildInfo = "Revision " & staticExec("git rev-parse HEAD") & ## const buildInfo = "Revision " & staticExec("git rev-parse HEAD") &
## "\nCompiled on " & staticExec("uname -v") ## "\nCompiled on " & staticExec("uname -v")
## ##
## ``gorge`` is an alias for ``staticExec``. Note that you can use this proc ## `gorge <#gorge>`_ is an alias for ``staticExec``. Note that you can use
## inside a pragma like `passC <nimrodc.html#passc-pragma>`_ or `passL ## this proc inside a pragma like `passC <nimrodc.html#passc-pragma>`_ or
## <nimrodc.html#passl-pragma>`_. ## `passL <nimrodc.html#passl-pragma>`_.
proc `+=`*[T: TOrdinal|uint|uint64](x: var T, y: T) {.magic: "Inc", noSideEffect.} proc `+=`*[T: TOrdinal|uint|uint64](x: var T, y: T) {.magic: "Inc", noSideEffect.}
## Increments an ordinal ## Increments an ordinal