Small changes to the docs to make it easier to find stuff.

This commit is contained in:
Hans Raaf 2016-07-21 15:08:42 +02:00
commit e412e5458c
2 changed files with 6 additions and 2 deletions

View file

@ -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.