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

system.nim: documentation fixes

Browse source
This commit is contained in:
Araq 2012-06-23 20:50:35 +02:00
commit 2d8138768a
2 changed files with 7 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

10
lib/system.nim
View file

@ -2212,9 +2212,9 @@ proc getTypeInfo*[T](x: T): pointer {.magic: "GetTypeInfo".}
proc slurp*(filename: string): string {.magic: "Slurp".} proc slurp*(filename: string): string {.magic: "Slurp".}
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`` proc for easy `resource`:idx: embedding:
## .. code-block:: nimrod
## ##
## const myResource = staticRead"mydatafile.bin" ## .. code-block:: nimrod
## const myResource = staticRead"mydatafile.bin"
## ##
## ``slurp`` is an alias for ``staticRead``. ## ``slurp`` is an alias for ``staticRead``.
@ -2225,10 +2225,10 @@ proc staticExec*(command: string, input = ""): string {.
## executes an external process at compile-time. ## executes an external process at compile-time.
## if `input` is not an empty string, it will be passed as a standard input ## if `input` is not an empty string, it will be passed as a standard input
## to the executed program. ## to the executed program.
## .. code-block:: nimrod
## ##
## const buildInfo = "Revision " & staticExec("git rev-parse HEAD") & ## .. code-block:: nimrod
## "\nCompiled on " & staticExec("uname -v") ## const buildInfo = "Revision " & staticExec("git rev-parse HEAD") &
## "\nCompiled on " & staticExec("uname -v")
## ##
## ``gorge`` is an alias for ``staticExec``. ## ``gorge`` is an alias for ``staticExec``.

3
todo.txt
View file

@ -1,6 +1,8 @@
version 0.9.0 version 0.9.0
============= =============
- change how comments are part of the AST
Debug GC session: Debug GC session:
- bug: stress testing basic method example (eval example) - bug: stress testing basic method example (eval example)
without ``-d:release`` leaks memory? without ``-d:release`` leaks memory?
@ -23,7 +25,6 @@ New pragmas:
- document 'do' notation - document 'do' notation
- unsigned ints and bignums; requires abstract integer literal type: - unsigned ints and bignums; requires abstract integer literal type:
use tyInt+node for that use tyInt+node for that
- change how comments are part of the AST
- document nimdoc properly finally - document nimdoc properly finally
- rethink the syntax: distinction between expr and stmt is unfortunate; - rethink the syntax: distinction between expr and stmt is unfortunate;
indentation handling is quite complex too; problem with exception handling indentation handling is quite complex too; problem with exception handling