various documentation fixes [backport] (#15422)

This commit is contained in:
Miran 2020-09-29 23:43:12 +02:00 • committed by GitHub
commit eb2a4961c7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 5 deletions

View file

@ -539,7 +539,7 @@ proc matchImpl(str: string, pattern: Regex, start, endpos: int, flags: int): Opt
raise RegexInternalError(msg: "Unknown internal error: " & $execRet) raise RegexInternalError(msg: "Unknown internal error: " & $execRet)
proc match*(str: string, pattern: Regex, start = 0, endpos = int.high): Option[RegexMatch] = 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(...)<#find,string,Regex,int>`_, but anchored to the start of the
## string. ## string.
## ##
runnableExamples: runnableExamples:
@ -549,11 +549,11 @@ proc match*(str: string, pattern: Regex, start = 0, endpos = int.high): Option[R
return str.matchImpl(pattern, start, endpos, pcre.ANCHORED) return str.matchImpl(pattern, start, endpos, pcre.ANCHORED)
iterator findIter*(str: string, pattern: Regex, start = 0, endpos = int.high): RegexMatch = 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(...)<#find,string,Regex,int>`_, but finds every
## non-overlapping match. ``"2222".find(re"22")`` is ``"22", "22"``, not ## non-overlapping match. ``"2222".find(re"22")`` is ``"22", "22"``, not
## ``"22", "22", "22"``. ## ``"22", "22", "22"``.
## ##
## Arguments are the same as ` ``find(...)`` <#proc-find>`_ ## Arguments are the same as `find(...)<#find,string,Regex,int>`_
## ##
## Variants: ## Variants:
## ##
@ -632,7 +632,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 ## Splits the string with the given regex. This works according to the
## rules that Perl and Javascript use. ## rules that Perl and Javascript use.
## ##
## ``start`` behaves the same as in ` ``find(...)`` <#proc-find>`_. ## ``start`` behaves the same as in `find(...)<#find,string,Regex,int>`_.
## ##
runnableExamples: runnableExamples:
# - If the match is zero-width, then the string is still split: # - If the match is zero-width, then the string is still split:

View file

@ -1930,7 +1930,7 @@ proc initSkipTable*(a: var SkipTable, sub: string)
proc find*(a: SkipTable, s, sub: string, start: Natural = 0, last = 0): int proc find*(a: SkipTable, s, sub: string, start: Natural = 0, last = 0): int
{.noSideEffect, rtl, extern: "nsuFindStrA".} = {.noSideEffect, rtl, extern: "nsuFindStrA".} =
## Searches for `sub` in `s` inside range `start`..`last` using preprocessed ## Searches for `sub` in `s` inside range `start..last` using preprocessed
## table `a`. If `last` is unspecified, it defaults to `s.high` (the last ## table `a`. If `last` is unspecified, it defaults to `s.high` (the last
## element). ## element).
## ##