make the stdlib work with the changed docgen
This commit is contained in:
parent
56b804a283
commit
647066e378
7 changed files with 10 additions and 10 deletions
|
|
@ -108,7 +108,7 @@ String handling
|
||||||
|
|
||||||
* `strformat <strformat.html>`_
|
* `strformat <strformat.html>`_
|
||||||
Macro based standard string interpolation / formatting. Inpired by
|
Macro based standard string interpolation / formatting. Inpired by
|
||||||
Python's ```f``-strings.
|
Python's ``f``-strings.
|
||||||
|
|
||||||
* `strmisc <strmisc.html>`_
|
* `strmisc <strmisc.html>`_
|
||||||
This module contains uncommon string handling operations that do not
|
This module contains uncommon string handling operations that do not
|
||||||
|
|
|
||||||
|
|
@ -151,7 +151,7 @@ proc `==`*(a, b: NimNode): bool {.magic: "EqNimrodNode", noSideEffect.}
|
||||||
|
|
||||||
proc `==`*(a, b: NimSym): bool {.magic: "EqNimrodNode", noSideEffect, deprecated.}
|
proc `==`*(a, b: NimSym): bool {.magic: "EqNimrodNode", noSideEffect, deprecated.}
|
||||||
## compares two Nim symbols
|
## compares two Nim symbols
|
||||||
## **Deprecated since version 0.18.1**; Use ```==`(NimNode,NimNode)`` instead.
|
## **Deprecated since version 0.18.1**; Use ``==(NimNode, NimNode)`` instead.
|
||||||
|
|
||||||
|
|
||||||
proc sameType*(a, b: NimNode): bool {.magic: "SameNodeType", noSideEffect.} =
|
proc sameType*(a, b: NimNode): bool {.magic: "SameNodeType", noSideEffect.} =
|
||||||
|
|
|
||||||
|
|
@ -205,7 +205,7 @@ proc `[]`*[T](c: var CritBitTree[T], key: string): var T {.inline,
|
||||||
proc mget*[T](c: var CritBitTree[T], key: string): var T {.inline, deprecated.} =
|
proc mget*[T](c: var CritBitTree[T], key: string): var T {.inline, deprecated.} =
|
||||||
## retrieves the value at ``c[key]``. The value can be modified.
|
## retrieves the value at ``c[key]``. The value can be modified.
|
||||||
## If `key` is not in `t`, the ``KeyError`` exception is raised.
|
## If `key` is not in `t`, the ``KeyError`` exception is raised.
|
||||||
## Use ```[]``` instead.
|
## Use ``[]`` instead.
|
||||||
get(c, key)
|
get(c, key)
|
||||||
|
|
||||||
iterator leaves[T](n: Node[T]): Node[T] =
|
iterator leaves[T](n: Node[T]): Node[T] =
|
||||||
|
|
|
||||||
|
|
@ -195,7 +195,7 @@ proc mget*[A](s: var HashSet[A], key: A): var A {.deprecated.} =
|
||||||
## returns the element that is actually stored in 's' which has the same
|
## returns the element that is actually stored in 's' which has the same
|
||||||
## value as 'key' or raises the ``KeyError`` exception. This is useful
|
## value as 'key' or raises the ``KeyError`` exception. This is useful
|
||||||
## when one overloaded 'hash' and '==' but still needs reference semantics
|
## when one overloaded 'hash' and '==' but still needs reference semantics
|
||||||
## for sharing. Use ```[]``` instead.
|
## for sharing. Use ``[]`` instead.
|
||||||
s[key]
|
s[key]
|
||||||
|
|
||||||
proc contains*[A](s: HashSet[A], key: A): bool =
|
proc contains*[A](s: HashSet[A], key: A): bool =
|
||||||
|
|
|
||||||
|
|
@ -271,7 +271,7 @@ proc peekStr*(s: Stream, length: int): TaintedString =
|
||||||
proc readLine*(s: Stream, line: var TaintedString): bool =
|
proc readLine*(s: Stream, line: var TaintedString): bool =
|
||||||
## reads a line of text from the stream `s` into `line`. `line` must not be
|
## reads a line of text from the stream `s` into `line`. `line` must not be
|
||||||
## ``nil``! May throw an IO exception.
|
## ``nil``! May throw an IO exception.
|
||||||
## A line of text may be delimited by ```LF`` or ``CRLF``.
|
## A line of text may be delimited by ``LF`` or ``CRLF``.
|
||||||
## The newline character(s) are not part of the returned string.
|
## The newline character(s) are not part of the returned string.
|
||||||
## Returns ``false`` if the end of the file has been reached, ``true``
|
## Returns ``false`` if the end of the file has been reached, ``true``
|
||||||
## otherwise. If ``false`` is returned `line` contains no new data.
|
## otherwise. If ``false`` is returned `line` contains no new data.
|
||||||
|
|
|
||||||
|
|
@ -418,7 +418,7 @@ proc prepareDealloc(cell: PCell) =
|
||||||
decTypeSize(cell, t)
|
decTypeSize(cell, t)
|
||||||
|
|
||||||
proc deallocHeap*(runFinalizers = true; allowGcAfterwards = true) =
|
proc deallocHeap*(runFinalizers = true; allowGcAfterwards = true) =
|
||||||
## Frees the thread local heap. Runs every finalizer if ``runFinalizers```
|
## Frees the thread local heap. Runs every finalizer if ``runFinalizers``
|
||||||
## is true. If ``allowGcAfterwards`` is true, a minimal amount of allocation
|
## is true. If ``allowGcAfterwards`` is true, a minimal amount of allocation
|
||||||
## happens to ensure the GC can continue to work after the call
|
## happens to ensure the GC can continue to work after the call
|
||||||
## to ``deallocHeap``.
|
## to ``deallocHeap``.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue