diff options
author | Andreas Rumpf <rumpf_a@web.de> | 2016-07-22 13:54:55 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-07-22 13:54:55 +0200 |
commit | c4fb9f052bf975a4fee2733bfd34068ab1440955 (patch) | |
tree | 97c3548b44c79211dd89717908cc3180107f11bd | |
parent | edcbfe991b3c6190fd5d10daaa996d635730393f (diff) | |
parent | e412e5458c5031086def6698aeb3b5ed57b6be82 (diff) | |
download | Nim-c4fb9f052bf975a4fee2733bfd34068ab1440955.tar.gz |
Merge pull request #4511 from oderwat/doc-changes1
Small changes to the docs to make it easier to find stuff.
-rw-r--r-- | lib/pure/os.nim | 2 | ||||
-rw-r--r-- | lib/system.nim | 6 |
2 files changed, 6 insertions, 2 deletions
diff --git a/lib/pure/os.nim b/lib/pure/os.nim index 5611b8f0c..9eb4cf57d 100644 --- a/lib/pure/os.nim +++ b/lib/pure/os.nim @@ -336,7 +336,7 @@ proc setCurrentDir*(newDir: string) {.inline, tags: [].} = proc expandFilename*(filename: string): string {.rtl, extern: "nos$1", tags: [ReadDirEffect].} = - ## Returns the full path of `filename`, raises OSError in case of an error. + ## Returns the full (`absolute`:idx:) path of the file `filename`, raises OSError in case of an error. when defined(windows): const bufsize = 3072'i32 when useWinUnicode: diff --git a/lib/system.nim b/lib/system.nim index 00eae7337..b4919db2d 100644 --- a/lib/system.nim +++ b/lib/system.nim @@ -3359,7 +3359,11 @@ proc astToStr*[T](x: T): string {.magic: "AstToStr", noSideEffect.} proc instantiationInfo*(index = -1, fullPaths = false): tuple[ filename: string, line: int] {. magic: "InstantiationInfo", noSideEffect.} - ## provides access to the compiler's instantiation stack line information. + ## provides access to the compiler's instantiation stack line information + ## of a template. + ## + ## While similar to the `caller info`:idx: of other languages, it is determined + ## at compile time. ## ## This proc is mostly useful for meta programming (eg. ``assert`` template) ## to retrieve information about the current filename and line number. |