Skip to content

Commit

Permalink
make the stdlib work with the changed docgen
Browse files Browse the repository at this point in the history
  • Loading branch information
Araq committed Jan 11, 2019
1 parent 56b804a commit 647066e
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion doc/lib.rst
Expand Up @@ -108,7 +108,7 @@ String handling

* `strformat <strformat.html>`_
Macro based standard string interpolation / formatting. Inpired by
Python's ```f``-strings.
Python's ``f``-strings.

* `strmisc <strmisc.html>`_
This module contains uncommon string handling operations that do not
Expand Down
2 changes: 1 addition & 1 deletion lib/core/macros.nim
Expand Up @@ -151,7 +151,7 @@ proc `==`*(a, b: NimNode): bool {.magic: "EqNimrodNode", noSideEffect.}

proc `==`*(a, b: NimSym): bool {.magic: "EqNimrodNode", noSideEffect, deprecated.}
## 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.} =
Expand Down
8 changes: 4 additions & 4 deletions lib/impure/nre.nim
Expand Up @@ -540,7 +540,7 @@ proc matchImpl(str: string, pattern: Regex, start, endpos: int, flags: int): Opt
raise RegexInternalError(msg : "Unknown internal error: " & $execRet)

proc match*(str: string, pattern: Regex, start = 0, endpos = int.high): Option[RegexMatch] =
## Like ```find(...)`` <#proc-find>`_, but anchored to the start of the
## Like ` ``find(...)`` <#proc-find>`_, but anchored to the start of the
## string.
##
runnableExamples:
Expand All @@ -550,11 +550,11 @@ proc match*(str: string, pattern: Regex, start = 0, endpos = int.high): Option[R
return str.matchImpl(pattern, start, endpos, pcre.ANCHORED)

iterator findIter*(str: string, pattern: Regex, start = 0, endpos = int.high): RegexMatch =
## Works the same as ```find(...)`` <#proc-find>`_, but finds every
## Works the same as ` ``find(...)`` <#proc-find>`_, but finds every
## non-overlapping match. ``"2222".find(re"22")`` is ``"22", "22"``, not
## ``"22", "22", "22"``.
##
## Arguments are the same as ```find(...)`` <#proc-find>`_
## Arguments are the same as ` ``find(...)`` <#proc-find>`_
##
## Variants:
##
Expand Down Expand Up @@ -633,7 +633,7 @@ proc split*(str: string, pattern: Regex, maxSplit = -1, start = 0): seq[string]
## Splits the string with the given regex. This works according to the
## rules that Perl and Javascript use.
##
## ``start`` behaves the same as in ```find(...)`` <#proc-find>`_.
## ``start`` behaves the same as in ` ``find(...)`` <#proc-find>`_.
##
runnableExamples:
# - If the match is zero-width, then the string is still split:
Expand Down
2 changes: 1 addition & 1 deletion lib/pure/collections/critbits.nim
Expand Up @@ -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.} =
## retrieves the value at ``c[key]``. The value can be modified.
## If `key` is not in `t`, the ``KeyError`` exception is raised.
## Use ```[]``` instead.
## Use ``[]`` instead.
get(c, key)

iterator leaves[T](n: Node[T]): Node[T] =
Expand Down
2 changes: 1 addition & 1 deletion lib/pure/collections/sets.nim
Expand Up @@ -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
## value as 'key' or raises the ``KeyError`` exception. This is useful
## when one overloaded 'hash' and '==' but still needs reference semantics
## for sharing. Use ```[]``` instead.
## for sharing. Use ``[]`` instead.
s[key]

proc contains*[A](s: HashSet[A], key: A): bool =
Expand Down
2 changes: 1 addition & 1 deletion lib/pure/streams.nim
Expand Up @@ -271,7 +271,7 @@ proc peekStr*(s: Stream, length: int): TaintedString =
proc readLine*(s: Stream, line: var TaintedString): bool =
## reads a line of text from the stream `s` into `line`. `line` must not be
## ``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.
## Returns ``false`` if the end of the file has been reached, ``true``
## otherwise. If ``false`` is returned `line` contains no new data.
Expand Down
2 changes: 1 addition & 1 deletion lib/system/gc_common.nim
Expand Up @@ -418,7 +418,7 @@ proc prepareDealloc(cell: PCell) =
decTypeSize(cell, t)

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
## happens to ensure the GC can continue to work after the call
## to ``deallocHeap``.
Expand Down

0 comments on commit 647066e

Please sign in to comment.