diff options
Diffstat (limited to 'lib')
-rw-r--r-- | lib/js/dom.nim | 2 | ||||
-rw-r--r-- | lib/js/jsconsole.nim | 2 | ||||
-rw-r--r-- | lib/packages/docutils/rstgen.nim | 14 | ||||
-rw-r--r-- | lib/posix/posix.nim | 2 | ||||
-rw-r--r-- | lib/pure/algorithm.nim | 2 | ||||
-rw-r--r-- | lib/pure/base64.nim | 4 | ||||
-rw-r--r-- | lib/pure/collections/lists.nim | 4 | ||||
-rw-r--r-- | lib/pure/collections/sequtils.nim | 2 | ||||
-rw-r--r-- | lib/pure/collections/sets.nim | 4 | ||||
-rw-r--r-- | lib/pure/collections/tables.nim | 4 | ||||
-rw-r--r-- | lib/pure/concurrency/threadpool.nim | 2 | ||||
-rw-r--r-- | lib/pure/htmlgen.nim | 2 | ||||
-rw-r--r-- | lib/pure/math.nim | 2 | ||||
-rw-r--r-- | lib/pure/memfiles.nim | 8 | ||||
-rw-r--r-- | lib/pure/parsecsv.nim | 6 | ||||
-rw-r--r-- | lib/pure/random.nim | 2 | ||||
-rw-r--r-- | lib/pure/streams.nim | 2 | ||||
-rw-r--r-- | lib/pure/strutils.nim | 50 | ||||
-rw-r--r-- | lib/std/sha1.nim | 6 | ||||
-rw-r--r-- | lib/system.nim | 20 | ||||
-rw-r--r-- | lib/system/assertions.nim | 2 | ||||
-rw-r--r-- | lib/system/nimscript.nim | 6 |
22 files changed, 74 insertions, 74 deletions
diff --git a/lib/js/dom.nim b/lib/js/dom.nim index efe281ce5..53d9cd204 100644 --- a/lib/js/dom.nim +++ b/lib/js/dom.nim @@ -8,7 +8,7 @@ # ## Declaration of the Document Object Model for the `JavaScript backend -## <backends.html#the-javascript-target>`_. +## <backends.html#backends-the-javascript-target>`_. when not defined(js) and not defined(Nimdoc): {.error: "This module only works on the JavaScript platform".} diff --git a/lib/js/jsconsole.nim b/lib/js/jsconsole.nim index 617cbebf1..199a5607e 100644 --- a/lib/js/jsconsole.nim +++ b/lib/js/jsconsole.nim @@ -8,7 +8,7 @@ # ## Wrapper for the `console` object for the `JavaScript backend -## <backends.html#the-javascript-target>`_. +## <backends.html#backends-the-javascript-target>`_. when not defined(js) and not defined(Nimdoc): {.error: "This module only works on the JavaScript platform".} diff --git a/lib/packages/docutils/rstgen.nim b/lib/packages/docutils/rstgen.nim index e5536868b..5a77ab618 100644 --- a/lib/packages/docutils/rstgen.nim +++ b/lib/packages/docutils/rstgen.nim @@ -154,7 +154,7 @@ proc writeIndexFile*(g: var RstGenerator, outfile: string) = ## Writes the current index buffer to the specified output file. ## ## You previously need to add entries to the index with the `setIndexTerm() - ## <#setIndexTerm>`_ proc. If the index is empty the file won't be created. + ## <#setIndexTerm,RstGenerator,string,string,string,string,string>`_ proc. If the index is empty the file won't be created. if g.theIndex.len > 0: writeFile(outfile, g.theIndex) proc addXmlChar(dest: var string, c: char) = @@ -308,7 +308,7 @@ proc setIndexTerm*(d: var RstGenerator, htmlFile, id, term: string, ## The `id` will be appended with a hash character only if its length is not ## zero, otherwise no specific anchor will be generated. In general you ## should only pass an empty `id` value for the title of standalone rst - ## documents (they are special for the `mergeIndexes() <#mergeIndexes>`_ + ## documents (they are special for the `mergeIndexes() <#mergeIndexes,string>`_ ## proc, see `Index (idx) file format <docgen.html#index-idx-file-format>`_ ## for more information). Unlike other index terms, title entries are ## inserted at the beginning of the accumulated buffer to maintain a logical @@ -318,8 +318,8 @@ proc setIndexTerm*(d: var RstGenerator, htmlFile, id, term: string, ## columns with their contents will be added. ## ## The index won't be written to disk unless you call `writeIndexFile() - ## <#writeIndexFile>`_. The purpose of the index is documented in the `docgen - ## tools guide <docgen.html#index-switch>`_. + ## <#writeIndexFile,RstGenerator,string>`_. The purpose of the index is documented in the `docgen + ## tools guide <docgen.html#related-options-index-switch>`_. var entry = term isTitle = false @@ -472,7 +472,7 @@ proc generateSymbolIndex(symbols: seq[IndexEntry]): string = proc isDocumentationTitle(hyperlink: string): bool = ## Returns true if the hyperlink is actually a documentation title. ## - ## Documentation titles lack the hash. See `mergeIndexes() <#mergeIndexes>`_ + ## Documentation titles lack the hash. See `mergeIndexes() <#mergeIndexes,string>`_ ## for a more detailed explanation. result = hyperlink.find('#') < 0 @@ -650,8 +650,8 @@ proc mergeIndexes*(dir: string): string = ## This proc will first scan `dir` for index files with the ``.idx`` ## extension previously created by commands like ``nim doc|rst2html`` ## which use the ``--index:on`` switch. These index files are the result of - ## calls to `setIndexTerm() <#setIndexTerm>`_ and `writeIndexFile() - ## <#writeIndexFile>`_, so they are simple tab separated files. + ## calls to `setIndexTerm() <#setIndexTerm,RstGenerator,string,string,string,string,string>`_ and `writeIndexFile() + ## <#writeIndexFile,RstGenerator,string>`_, so they are simple tab separated files. ## ## As convention this proc will split index files into two categories: ## documentation and API. API indices will be all joined together into a diff --git a/lib/posix/posix.nim b/lib/posix/posix.nim index 8fcb9cb5c..044e0448f 100644 --- a/lib/posix/posix.nim +++ b/lib/posix/posix.nim @@ -584,7 +584,7 @@ proc fchmod*(a1: cint, a2: Mode): cint {.importc, header: "<sys/stat.h>".} proc fstat*(a1: cint, a2: var Stat): cint {.importc, header: "<sys/stat.h>".} proc lstat*(a1: cstring, a2: var Stat): cint {.importc, header: "<sys/stat.h>".} proc mkdir*(a1: cstring, a2: Mode): cint {.importc, header: "<sys/stat.h>".} - ## Use `os.createDir() <os.html#createDir>`_ and similar. + ## Use `os.createDir() <os.html#createDir,string>`_ and similar. proc mkfifo*(a1: cstring, a2: Mode): cint {.importc, header: "<sys/stat.h>".} proc mknod*(a1: cstring, a2: Mode, a3: Dev): cint {. diff --git a/lib/pure/algorithm.nim b/lib/pure/algorithm.nim index 522ff1b16..d40b2fd63 100644 --- a/lib/pure/algorithm.nim +++ b/lib/pure/algorithm.nim @@ -392,7 +392,7 @@ func sort*[T](a: var openArray[T], ## sort(myStrArray, system.cmp) ## ## You can inline adhoc comparison procs with the `do notation - ## <manual.html#procedures-do-notation>`_. Example: + ## <manual_experimental.html#do-notation>`_. Example: ## ## .. code-block:: nim ## diff --git a/lib/pure/base64.nim b/lib/pure/base64.nim index 615af24d1..65cae2a1d 100644 --- a/lib/pure/base64.nim +++ b/lib/pure/base64.nim @@ -175,8 +175,8 @@ proc decode*(s: string): string = ## The initial whitespace is skipped. ## ## **See also:** - ## * `encode proc<#encode,openArray[T],int,string>`_ for encoding an openarray - ## * `encode proc<#encode,string,int,string>`_ for encoding a string + ## * `encode proc<#encode,openArray[T]>`_ for encoding an openarray + ## * `encode proc<#encode,string>`_ for encoding a string runnableExamples: assert decode("SGVsbG8gV29ybGQ=") == "Hello World" assert decode(" SGVsbG8gV29ybGQ=") == "Hello World" diff --git a/lib/pure/collections/lists.nim b/lib/pure/collections/lists.nim index 4118290b6..b95cfffc0 100644 --- a/lib/pure/collections/lists.nim +++ b/lib/pure/collections/lists.nim @@ -69,8 +69,8 @@ ## See also ## ======== ## -## * `deques module <#deques.html>`_ for double-ended queues -## * `sharedlist module <#sharedlist.html>`_ for shared singly-linked lists +## * `deques module <deques.html>`_ for double-ended queues +## * `sharedlist module <sharedlist.html>`_ for shared singly-linked lists when not defined(nimhygiene): diff --git a/lib/pure/collections/sequtils.nim b/lib/pure/collections/sequtils.nim index 00bb0300d..9ea8c44f7 100644 --- a/lib/pure/collections/sequtils.nim +++ b/lib/pure/collections/sequtils.nim @@ -35,7 +35,7 @@ ## `filterIt<#filterIt.t,untyped,untyped>`_, etc.) ## ## The chaining of functions is possible thanks to the -## `method call syntax<manual.html#procs-method-call-syntax>`_. +## `method call syntax<manual.html#procedures-method-call-syntax>`_. ## ## .. code-block:: ## import sequtils, sugar diff --git a/lib/pure/collections/sets.nim b/lib/pure/collections/sets.nim index 4b896b12b..431534d1e 100644 --- a/lib/pure/collections/sets.nim +++ b/lib/pure/collections/sets.nim @@ -99,7 +99,7 @@ proc init*[A](s: var HashSet[A], initialSize = defaultInitialSize) = ## ## The `initialSize` parameter needs to be a power of two (default: 64). ## If you need to accept runtime values for this, you can use - ## `math.nextPowerOfTwo proc <math.html#nextPowerOfTwo>`_ or `rightSize proc + ## `math.nextPowerOfTwo proc <math.html#nextPowerOfTwo,int>`_ or `rightSize proc ## <#rightSize,Natural>`_ from this module. ## ## Starting from Nim v0.20, sets are initialized by default and it is @@ -645,7 +645,7 @@ proc init*[A](s: var OrderedSet[A], initialSize = defaultInitialSize) = ## ## The `initialSize` parameter needs to be a power of two (default: 64). ## If you need to accept runtime values for this, you can use - ## `math.nextPowerOfTwo proc <math.html#nextPowerOfTwo>`_ or `rightSize proc + ## `math.nextPowerOfTwo proc <math.html#nextPowerOfTwo,int>`_ or `rightSize proc ## <#rightSize,Natural>`_ from this module. ## ## Starting from Nim v0.20, sets are initialized by default and it is diff --git a/lib/pure/collections/tables.nim b/lib/pure/collections/tables.nim index 3c91ba9c7..a5ee74f8b 100644 --- a/lib/pure/collections/tables.nim +++ b/lib/pure/collections/tables.nim @@ -134,7 +134,7 @@ ## # 'a': 5, 'b': 2, 'c': 1, 'd': 1, 'r': 2} ## ## The same could have been achieved by manually iterating over a container -## and increasing each key's value with `inc proc<#inc,CountTable[A],A,int>`_: +## and increasing each key's value with `inc proc<#inc,CountTable[A],A,Positive>`_: ## ## .. code-block:: ## import tables @@ -2236,7 +2236,7 @@ proc `[]=`*[A](t: var CountTable[A], key: A, val: int) = ## ## See also: ## * `[] proc<#[],CountTable[A],A>`_ for retrieving a value of a key - ## * `inc proc<#inc,CountTable[A],A,int>`_ for incrementing a + ## * `inc proc<#inc,CountTable[A],A,Positive>`_ for incrementing a ## value of a key assert(not t.isSorted, "CountTable must not be used after sorting") assert val >= 0 diff --git a/lib/pure/concurrency/threadpool.nim b/lib/pure/concurrency/threadpool.nim index d6506cd76..1f7df7c00 100644 --- a/lib/pure/concurrency/threadpool.nim +++ b/lib/pure/concurrency/threadpool.nim @@ -487,7 +487,7 @@ proc parallel*(body: untyped) {.magic: "Parallel".} ## ## ``body`` has to be in a DSL that is a particular subset of the language. ## - ## Please refer to `the manual <manual.html#parallel-amp-spawn>`_ + ## Please refer to `the manual <manual_experimental.html#parallel-amp-spawn>`_ ## for further information. var diff --git a/lib/pure/htmlgen.nim b/lib/pure/htmlgen.nim index ebd46df53..4887e6144 100644 --- a/lib/pure/htmlgen.nim +++ b/lib/pure/htmlgen.nim @@ -11,7 +11,7 @@ ## as ``from htmlgen import nil`` and then fully qualify the macros. ## ## *Note*: The Karax project (``nimble install karax``) has a better -## way to achieve the same, see `https://github.com/pragmagic/karax/blob/master/tests/nativehtmlgen.nim`_ +## way to achieve the same, see https://github.com/pragmagic/karax/blob/master/tests/nativehtmlgen.nim ## for an example. ## ## diff --git a/lib/pure/math.nim b/lib/pure/math.nim index 79a8675a6..af54bd506 100644 --- a/lib/pure/math.nim +++ b/lib/pure/math.nim @@ -35,7 +35,7 @@ ## # nan (use `complex` module) ## ## This module is available for the `JavaScript target -## <backends.html#the-javascript-target>`_. +## <backends.html#backends-the-javascript-target>`_. ## ## **See also:** ## * `complex module<complex.html>`_ for complex numbers and their diff --git a/lib/pure/memfiles.nim b/lib/pure/memfiles.nim index 411df1456..df4a1ee4e 100644 --- a/lib/pure/memfiles.nim +++ b/lib/pure/memfiles.nim @@ -431,9 +431,9 @@ iterator memSlices*(mfile: MemFile, delim = '\l', eat = '\r'): MemSlice {.inline iterator lines*(mfile: MemFile, buf: var TaintedString, delim = '\l', eat = '\r'): TaintedString {.inline.} = ## Replace contents of passed buffer with each new line, like - ## `readLine(File) <system.html#readLine,File,TaintedString>`_. + ## `readLine(File) <io.html#readLine,File,TaintedString>`_. ## `delim`, `eat`, and delimiting logic is exactly as for - ## `memSlices <#memSlices>`_, but Nim strings are returned. + ## `memSlices <#memSlices.i,MemFile,char,char>`_, but Nim strings are returned. ## ## Example: ## @@ -450,9 +450,9 @@ iterator lines*(mfile: MemFile, buf: var TaintedString, delim = '\l', iterator lines*(mfile: MemFile, delim = '\l', eat = '\r'): TaintedString {.inline.} = ## Return each line in a file as a Nim string, like - ## `lines(File) <system.html#lines.i,File>`_. + ## `lines(File) <io.html#lines.i,File>`_. ## `delim`, `eat`, and delimiting logic is exactly as for - ## `memSlices <#memSlices>`_, but Nim strings are returned. + ## `memSlices <#memSlices.i,MemFile,char,char>`_, but Nim strings are returned. ## ## Example: ## diff --git a/lib/pure/parsecsv.nim b/lib/pure/parsecsv.nim index 741ce33b8..44703e3f8 100644 --- a/lib/pure/parsecsv.nim +++ b/lib/pure/parsecsv.nim @@ -57,7 +57,7 @@ ## ======== ## ## * `streams module <streams.html>`_ for using -## `open proc <#open,CsvParser,Stream,string,Char,Char,Char>`_ +## `open proc <#open,CsvParser,Stream,string,char,char,char>`_ ## and other stream processing (like `close proc <streams.html#close,Stream>`_) ## * `parseopt module <parseopt.html>`_ for a command line parser ## * `parsecfg module <parsecfg.html>`_ for a configuration file parser @@ -117,7 +117,7 @@ proc open*(my: var CsvParser, input: Stream, filename: string, ## `separator` is ignored. ## ## See also: - ## * `open proc <#open,CsvParser,string,Char,Char,Char>`_ which creates the + ## * `open proc <#open,CsvParser,string,char,char,char>`_ which creates the ## file stream for you runnableExamples: import streams @@ -139,7 +139,7 @@ proc open*(my: var CsvParser, input: Stream, filename: string, proc open*(my: var CsvParser, filename: string, separator = ',', quote = '"', escape = '\0', skipInitialSpace = false) = - ## Similar to the `other open proc<#open,CsvParser,Stream,string,Char,Char,Char>`_, + ## Similar to the `other open proc<#open,CsvParser,Stream,string,char,char,char>`_, ## but creates the file stream for you. runnableExamples: from os import removeFile diff --git a/lib/pure/random.nim b/lib/pure/random.nim index 72e9f91f0..7283547d6 100644 --- a/lib/pure/random.nim +++ b/lib/pure/random.nim @@ -75,7 +75,7 @@ ## generator ## * `stats module<stats.html>`_ for statistical analysis ## * `list of cryptographic and hashing modules -## <lib.html#pure-libraries-cryptography-and-hashing>`_ +## <lib.html#pure-libraries-hashing>`_ ## in the standard library import algorithm #For upperBound diff --git a/lib/pure/streams.nim b/lib/pure/streams.nim index 3850d10e2..c9547eee1 100644 --- a/lib/pure/streams.nim +++ b/lib/pure/streams.nim @@ -1223,7 +1223,7 @@ else: ## * `newStringStream proc <#newStringStream,string>`_ creates a new stream ## from string. ## * `newFileStream proc <#newFileStream,string,FileMode,int>`_ is the same - ## as using `open proc <system.html#open,File,string,FileMode,int>`_ + ## as using `open proc <io.html#open,File,string,FileMode,int>`_ ## on Examples. ## * `openFileStream proc <#openFileStream,string,FileMode,int>`_ creates a ## file stream from the file name and the mode. diff --git a/lib/pure/strutils.nim b/lib/pure/strutils.nim index 69cb1efd5..a2bcfd339 100644 --- a/lib/pure/strutils.nim +++ b/lib/pure/strutils.nim @@ -50,7 +50,7 @@ ## "Beetlejuice Beetlejuice Beetlejuice" ## ## This module is available for the `JavaScript target -## <backends.html#the-javascript-target>`_. +## <backends.html#backends-the-javascript-target>`_. ## ## ---- ## @@ -209,7 +209,7 @@ proc toLowerAscii*(c: char): char {.noSideEffect, procvar, ## Returns the lower case version of character ``c``. ## ## This works only for the letters ``A-Z``. See `unicode.toLower - ## <unicode.html#toLower>`_ for a version that works for any Unicode + ## <unicode.html#toLower,Rune>`_ for a version that works for any Unicode ## character. ## ## See also: @@ -233,7 +233,7 @@ proc toLowerAscii*(s: string): string {.noSideEffect, procvar, ## Converts string `s` into lower case. ## ## This works only for the letters ``A-Z``. See `unicode.toLower - ## <unicode.html#toLower>`_ for a version that works for any Unicode + ## <unicode.html#toLower,string>`_ for a version that works for any Unicode ## character. ## ## See also: @@ -247,7 +247,7 @@ proc toUpperAscii*(c: char): char {.noSideEffect, procvar, ## Converts character `c` into upper case. ## ## This works only for the letters ``A-Z``. See `unicode.toUpper - ## <unicode.html#toUpper>`_ for a version that works for any Unicode + ## <unicode.html#toUpper,Rune>`_ for a version that works for any Unicode ## character. ## ## See also: @@ -267,7 +267,7 @@ proc toUpperAscii*(s: string): string {.noSideEffect, procvar, ## Converts string `s` into upper case. ## ## This works only for the letters ``A-Z``. See `unicode.toUpper - ## <unicode.html#toUpper>`_ for a version that works for any Unicode + ## <unicode.html#toUpper,string>`_ for a version that works for any Unicode ## character. ## ## See also: @@ -631,7 +631,7 @@ iterator rsplit*(s: string, sep: string, maxsplit: int = -1, iterator splitLines*(s: string, keepEol = false): string = ## Splits the string `s` into its containing lines. ## - ## Every `character literal <manual.html#character-literals>`_ newline + ## Every `character literal <manual.html#lexical-analysis-character-literals>`_ newline ## combination (CR, LF, CR-LF) is supported. The result strings contain no ## trailing end of line characters unless parameter ``keepEol`` is set to ## ``true``. @@ -1308,8 +1308,8 @@ proc spaces*(n: Natural): string {.inline.} = ## to left align strings. ## ## See also: - ## * `align proc<#align,string,Natural,Char>`_ - ## * `alignLeft proc<#alignLeft,string,Natural,Char>`_ + ## * `align proc<#align,string,Natural,char>`_ + ## * `alignLeft proc<#alignLeft,string,Natural,char>`_ ## * `indent proc<#indent,string,Natural,string>`_ ## * `center proc<#center,string,int,char>`_ runnableExamples: @@ -1330,10 +1330,10 @@ proc align*(s: string, count: Natural, padding = ' '): string {. ## `padding` characters (by default spaces) are added before `s` resulting in ## right alignment. If ``s.len >= count``, no spaces are added and `s` is ## returned unchanged. If you need to left align a string use the `alignLeft - ## proc <#alignLeft,string,Natural,Char>`_. + ## proc <#alignLeft,string,Natural,char>`_. ## ## See also: - ## * `alignLeft proc<#alignLeft,string,Natural,Char>`_ + ## * `alignLeft proc<#alignLeft,string,Natural,char>`_ ## * `spaces proc<#spaces,Natural>`_ ## * `indent proc<#indent,string,Natural,string>`_ ## * `center proc<#center,string,int,char>`_ @@ -1357,10 +1357,10 @@ proc alignLeft*(s: string, count: Natural, padding = ' '): string {. ## `padding` characters (by default spaces) are added after `s` resulting in ## left alignment. If ``s.len >= count``, no spaces are added and `s` is ## returned unchanged. If you need to right align a string use the `align - ## proc <#align,string,Natural,Char>`_. + ## proc <#align,string,Natural,char>`_. ## ## See also: - ## * `align proc<#align,string,Natural,Char>`_ + ## * `align proc<#align,string,Natural,char>`_ ## * `spaces proc<#spaces,Natural>`_ ## * `indent proc<#indent,string,Natural,string>`_ ## * `center proc<#center,string,int,char>`_ @@ -1387,8 +1387,8 @@ proc center*(s: string, width: int, fillChar: char = ' '): string {. ## to `s.len`. ## ## See also: - ## * `align proc<#align,string,Natural,Char>`_ - ## * `alignLeft proc<#alignLeft,string,Natural,Char>`_ + ## * `align proc<#align,string,Natural,char>`_ + ## * `alignLeft proc<#alignLeft,string,Natural,char>`_ ## * `spaces proc<#spaces,Natural>`_ ## * `indent proc<#indent,string,Natural,string>`_ runnableExamples: @@ -1420,8 +1420,8 @@ proc indent*(s: string, count: Natural, padding: string = " "): string ## **Note:** This does not preserve the new line characters used in ``s``. ## ## See also: - ## * `align proc<#align,string,Natural,Char>`_ - ## * `alignLeft proc<#alignLeft,string,Natural,Char>`_ + ## * `align proc<#align,string,Natural,char>`_ + ## * `alignLeft proc<#alignLeft,string,Natural,char>`_ ## * `spaces proc<#spaces,Natural>`_ ## * `unindent proc<#unindent,string,Natural,string>`_ runnableExamples: @@ -1445,8 +1445,8 @@ proc unindent*(s: string, count: Natural, padding: string = " "): string ## **Note:** This does not preserve the new line characters used in ``s``. ## ## See also: - ## * `align proc<#align,string,Natural,Char>`_ - ## * `alignLeft proc<#alignLeft,string,Natural,Char>`_ + ## * `align proc<#align,string,Natural,char>`_ + ## * `alignLeft proc<#alignLeft,string,Natural,char>`_ ## * `spaces proc<#spaces,Natural>`_ ## * `indent proc<#indent,string,Natural,string>`_ runnableExamples: @@ -1471,8 +1471,8 @@ proc unindent*(s: string): string ## Removes all indentation composed of whitespace from each line in ``s``. ## ## See also: - ## * `align proc<#align,string,Natural,Char>`_ - ## * `alignLeft proc<#alignLeft,string,Natural,Char>`_ + ## * `align proc<#align,string,Natural,char>`_ + ## * `alignLeft proc<#alignLeft,string,Natural,char>`_ ## * `spaces proc<#spaces,Natural>`_ ## * `indent proc<#indent,string,Natural,string>`_ runnableExamples: @@ -1862,7 +1862,7 @@ proc find*(s: string, sub: char, start: Natural = 0, last = 0): int {.noSideEffe ## Use `s[start..last].rfind` for a ``start``-origin index. ## ## See also: - ## * `rfind proc<#rfind,string,char,int,int>`_ + ## * `rfind proc<#rfind,string,char,Natural,int>`_ ## * `replace proc<#replace,string,char,char>`_ let last = if last == 0: s.high else: last when nimvm: @@ -1890,7 +1890,7 @@ proc find*(s: string, chars: set[char], start: Natural = 0, last = 0): int {.noS ## Use `s[start..last].find` for a ``start``-origin index. ## ## See also: - ## * `rfind proc<#rfind,string,set[char],int,int>`_ + ## * `rfind proc<#rfind,string,set[char],Natural,int>`_ ## * `multiReplace proc<#multiReplace,string,varargs[]>`_ let last = if last == 0: s.high else: last for i in int(start)..last: @@ -1907,7 +1907,7 @@ proc find*(s, sub: string, start: Natural = 0, last = 0): int {.noSideEffect, ## Use `s[start..last].find` for a ``start``-origin index. ## ## See also: - ## * `rfind proc<#rfind,string,string,int,int>`_ + ## * `rfind proc<#rfind,string,string,Natural,int>`_ ## * `replace proc<#replace,string,string,string>`_ if sub.len > s.len: return -1 if sub.len == 1: return find(s, sub[0], start, last) @@ -1927,7 +1927,7 @@ proc rfind*(s: string, sub: char, start: Natural = 0, last = -1): int {.noSideEf ## Use `s[start..last].find` for a ``start``-origin index. ## ## See also: - ## * `find proc<#find,string,char,int,int>`_ + ## * `find proc<#find,string,char,Natural,int>`_ let last = if last == -1: s.high else: last for i in countdown(last, start): if sub == s[i]: return i @@ -2101,7 +2101,7 @@ proc replace*(s: string, sub, by: char): string {.noSideEffect, rtl, extern: "nsuReplaceChar".} = ## Replaces `sub` in `s` by the character `by`. ## - ## Optimized version of `replace <#replace,string,string>`_ for characters. + ## Optimized version of `replace <#replace,string,string,string>`_ for characters. ## ## See also: ## * `find proc<#find,string,char,Natural,int>`_ diff --git a/lib/std/sha1.nim b/lib/std/sha1.nim index 0099d5f6d..8f35a44ff 100644 --- a/lib/std/sha1.nim +++ b/lib/std/sha1.nim @@ -211,7 +211,7 @@ proc secureHashFile*(filename: string): SecureHash = ## Generates a ``SecureHash`` from a file. ## ## **See also:** - ## * `secureHash proc <#secureHash,string>`_ for generating a ``SecureHash`` from a string + ## * `secureHash proc <#secureHash,openArray[char]>`_ for generating a ``SecureHash`` from a string ## * `parseSecureHash proc <#parseSecureHash,string>`_ for converting a string ``hash`` to ``SecureHash`` secureHash(readFile(filename)) @@ -219,7 +219,7 @@ proc `$`*(self: SecureHash): string = ## Returns the string representation of a ``SecureHash``. ## ## **See also:** - ## * `secureHash proc <#secureHash,string>`_ for generating a ``SecureHash`` from a string + ## * `secureHash proc <#secureHash,openArray[char]>`_ for generating a ``SecureHash`` from a string runnableExamples: let hash = secureHash("Hello World") assert $hash == "0A4D55A8D778E5022FAB701977C5D840BBC486D0" @@ -231,7 +231,7 @@ proc parseSecureHash*(hash: string): SecureHash = ## Converts a string ``hash`` to ``SecureHash``. ## ## **See also:** - ## * `secureHash proc <#secureHash,string>`_ for generating a ``SecureHash`` from a string + ## * `secureHash proc <#secureHash,openArray[char]>`_ for generating a ``SecureHash`` from a string ## * `secureHashFile proc <#secureHashFile,string>`_ for generating a ``SecureHash`` from a file runnableExamples: let diff --git a/lib/system.nim b/lib/system.nim index 5e1bcd309..9ecfa1192 100644 --- a/lib/system.nim +++ b/lib/system.nim @@ -112,7 +112,7 @@ proc defined*(x: untyped): bool {.magic: "Defined", noSideEffect, compileTime.} ## defined. ## ## `x` is an external symbol introduced through the compiler's - ## `-d:x switch <nimc.html#compile-time-symbols>`_ to enable build time + ## `-d:x switch <nimc.html#compiler-usage-compile-time-symbols>`_ to enable build time ## conditionals: ## ## .. code-block:: Nim @@ -784,7 +784,7 @@ type AssertionError* = object of Defect ## \ ## Raised when assertion is proved wrong. ## - ## Usually the result of using the `assert() template <#assert>`_. + ## Usually the result of using the `assert() template <assertions.html#assert.t,untyped,string>`_. ValueError* = object of CatchableError ## \ ## Raised for string and object conversion errors. KeyError* = object of ValueError ## \ @@ -2017,7 +2017,7 @@ when defined(boehmgc): when taintMode: type TaintedString* = distinct string ## A distinct string type that ## is `tainted`:idx:, see `taint mode - ## <manual.html#taint-mode>`_ for + ## <manual_experimental.html#taint-mode>`_ for ## details. It is an alias for ## ``string`` if the taint mode is not ## turned on. @@ -2026,7 +2026,7 @@ when taintMode: else: type TaintedString* = string ## A distinct string type that ## is `tainted`:idx:, see `taint mode - ## <manual.html#taint-mode>`_ for + ## <manual_experimental.html#taint-mode>`_ for ## details. It is an alias for ## ``string`` if the taint mode is not ## turned on. @@ -2040,11 +2040,11 @@ else: const QuitSuccess* = 0 - ## is the value that should be passed to `quit <#quit>`_ to indicate + ## is the value that should be passed to `quit <#quit,int>`_ to indicate ## success. QuitFailure* = 1 - ## is the value that should be passed to `quit <#quit>`_ to indicate + ## is the value that should be passed to `quit <#quit,int>`_ to indicate ## failure. when defined(nodejs) and not defined(nimscript): @@ -3460,14 +3460,14 @@ when defined(nimvarargstyped): ## Unlike other IO operations this is guaranteed to be thread-safe as ## ``echo`` is very often used for debugging convenience. If you want to use ## ``echo`` inside a `proc without side effects - ## <manual.html#pragmas-noSideEffect-pragma>`_ you can use `debugEcho <#debugEcho>`_ + ## <manual.html#pragmas-nosideeffect-pragma>`_ you can use `debugEcho <#debugEcho,varargs[typed,]>`_ ## instead. proc debugEcho*(x: varargs[typed, `$`]) {.magic: "Echo", noSideEffect, tags: [], raises: [].} - ## Same as `echo <#echo>`_, but as a special semantic rule, ``debugEcho`` + ## Same as `echo <#echo,varargs[typed,]>`_, but as a special semantic rule, ``debugEcho`` ## pretends to be free of side effects, so that it can be used for debugging - ## routines marked as `noSideEffect <manual.html#pragmas-noSideEffect-pragma>`_. + ## routines marked as `noSideEffect <manual.html#pragmas-nosideeffect-pragma>`_. else: proc echo*(x: varargs[untyped, `$`]) {.magic: "Echo", tags: [WriteIOEffect], benign, sideEffect.} @@ -4092,7 +4092,7 @@ proc staticExec*(command: string, input = "", cache = ""): string {. ## `gorge <#gorge,string,string,string>`_ is an alias for ``staticExec``. ## ## Note that you can use this proc inside a pragma like - ## `passc <nimc.html#passc-pragma>`_ or `passl <nimc.html#passl-pragma>`_. + ## `passc <manual.html#implementation-specific-pragmas-passc-pragma>`_ or `passl <manual.html#implementation-specific-pragmas-passl-pragma>`_. ## ## If ``cache`` is not empty, the results of ``staticExec`` are cached within ## the ``nimcache`` directory. Use ``--forceBuild`` to get rid of this caching diff --git a/lib/system/assertions.nim b/lib/system/assertions.nim index 2131394e0..e0110d5c0 100644 --- a/lib/system/assertions.nim +++ b/lib/system/assertions.nim @@ -45,7 +45,7 @@ template assert*(cond: untyped, msg = "") = ## ## The compiler may not generate any code at all for ``assert`` if it is ## advised to do so through the ``-d:release`` or ``--assertions:off`` - ## `command line switches <nimc.html#command-line-switches>`_. + ## `command line switches <nimc.html#compiler-usage-command-line-switches>`_. const expr = astToStr(cond) assertImpl(cond, msg, expr, compileOption("assertions")) diff --git a/lib/system/nimscript.nim b/lib/system/nimscript.nim index 6f795d075..7a1a45b1a 100644 --- a/lib/system/nimscript.nim +++ b/lib/system/nimscript.nim @@ -312,8 +312,8 @@ proc cd*(dir: string) {.raises: [OSError].} = ## ## The change is permanent for the rest of the execution, since this is just ## a shortcut for `os.setCurrentDir() - ## <http://nim-lang.org/docs/os.html#setCurrentDir,string>`_ . Use the `withDir() - ## <#withDir>`_ template if you want to perform a temporary change only. + ## <os.html#setCurrentDir,string>`_ . Use the `withDir() + ## <#withDir.t,string,untyped>`_ template if you want to perform a temporary change only. setCurrentDir(dir) checkOsError() @@ -326,7 +326,7 @@ proc findExe*(bin: string): string = template withDir*(dir: string; body: untyped): untyped = ## Changes the current directory temporarily. ## - ## If you need a permanent change, use the `cd() <#cd>`_ proc. Usage example: + ## If you need a permanent change, use the `cd() <#cd,string>`_ proc. Usage example: ## ## .. code-block:: nim ## withDir "foo": |