[other] documentation: deprecation comments are now auto-generated

This commit is contained in:
narimiran 2019-06-19 14:21:46 +02:00
commit cf47c2c60c
2 changed files with 1 additions and 21 deletions

View file

@ -847,9 +847,7 @@ template mapIt*(s: typed, op: untyped): untyped =
result result
template mapIt*(s, typ, op: untyped): untyped {.error: template mapIt*(s, typ, op: untyped): untyped {.error:
"Use 'mapIt(seq1, op)' - without specifying the type of the returned seqence".} = "Deprecated since v0.12; Use 'mapIt(seq1, op)' - without specifying the type of the returned seqence".} =
## **Deprecated since version 0.12.0:** Use the `mapIt(seq1, op) template
## <#mapIt.t,typed,untyped>`_ instead.
var result: seq[typ] = @[] var result: seq[typ] = @[]
for it {.inject.} in items(s): for it {.inject.} in items(s):
result.add(op) result.add(op)

View file

@ -2856,8 +2856,6 @@ iterator tokenize*(s: string, seps: set[char] = Whitespace): tuple[
proc editDistance*(a, b: string): int {.noSideEffect, proc editDistance*(a, b: string): int {.noSideEffect,
rtl, extern: "nsuEditDistance", rtl, extern: "nsuEditDistance",
deprecated: "use editdistance.editDistanceAscii instead".} = deprecated: "use editdistance.editDistanceAscii instead".} =
## **Deprecated**: Use `editdistance module<editdistance.html>`_
##
## Returns the edit distance between `a` and `b`. ## Returns the edit distance between `a` and `b`.
## ##
## This uses the `Levenshtein`:idx: distance algorithm with only a linear ## This uses the `Levenshtein`:idx: distance algorithm with only a linear
@ -2948,8 +2946,6 @@ proc editDistance*(a, b: string): int {.noSideEffect,
proc isNilOrEmpty*(s: string): bool {.noSideEffect, procvar, rtl, proc isNilOrEmpty*(s: string): bool {.noSideEffect, procvar, rtl,
extern: "nsuIsNilOrEmpty", extern: "nsuIsNilOrEmpty",
deprecated: "use 'x.len == 0' instead".} = deprecated: "use 'x.len == 0' instead".} =
## **Deprecated**: use 'x.len == 0'
##
## Checks if `s` is nil or empty. ## Checks if `s` is nil or empty.
result = len(s) == 0 result = len(s) == 0
@ -2969,8 +2965,6 @@ template isImpl(call) =
proc isAlphaAscii*(s: string): bool {.noSideEffect, procvar, proc isAlphaAscii*(s: string): bool {.noSideEffect, procvar,
rtl, extern: "nsuIsAlphaAsciiStr", rtl, extern: "nsuIsAlphaAsciiStr",
deprecated: "Deprecated since version 0.20 since its semantics are unclear".} = deprecated: "Deprecated since version 0.20 since its semantics are unclear".} =
## **Deprecated**: Deprecated since version 0.20 since its semantics are unclear
##
## Checks whether or not `s` is alphabetical. ## Checks whether or not `s` is alphabetical.
## ##
## This checks a-z, A-Z ASCII characters only. ## This checks a-z, A-Z ASCII characters only.
@ -2987,8 +2981,6 @@ proc isAlphaAscii*(s: string): bool {.noSideEffect, procvar,
proc isAlphaNumeric*(s: string): bool {.noSideEffect, procvar, proc isAlphaNumeric*(s: string): bool {.noSideEffect, procvar,
rtl, extern: "nsuIsAlphaNumericStr", rtl, extern: "nsuIsAlphaNumericStr",
deprecated: "Deprecated since version 0.20 since its semantics are unclear".} = deprecated: "Deprecated since version 0.20 since its semantics are unclear".} =
## **Deprecated**: Deprecated since version 0.20 since its semantics are unclear
##
## Checks whether or not `s` is alphanumeric. ## Checks whether or not `s` is alphanumeric.
## ##
## This checks a-z, A-Z, 0-9 ASCII characters only. ## This checks a-z, A-Z, 0-9 ASCII characters only.
@ -3005,8 +2997,6 @@ proc isAlphaNumeric*(s: string): bool {.noSideEffect, procvar,
proc isDigit*(s: string): bool {.noSideEffect, procvar, proc isDigit*(s: string): bool {.noSideEffect, procvar,
rtl, extern: "nsuIsDigitStr", rtl, extern: "nsuIsDigitStr",
deprecated: "Deprecated since version 0.20 since its semantics are unclear".} = deprecated: "Deprecated since version 0.20 since its semantics are unclear".} =
## **Deprecated**: Deprecated since version 0.20 since its semantics are unclear
##
## Checks whether or not `s` is a numeric value. ## Checks whether or not `s` is a numeric value.
## ##
## This checks 0-9 ASCII characters only. ## This checks 0-9 ASCII characters only.
@ -3021,8 +3011,6 @@ proc isDigit*(s: string): bool {.noSideEffect, procvar,
proc isSpaceAscii*(s: string): bool {.noSideEffect, procvar, proc isSpaceAscii*(s: string): bool {.noSideEffect, procvar,
rtl, extern: "nsuIsSpaceAsciiStr", rtl, extern: "nsuIsSpaceAsciiStr",
deprecated: "Deprecated since version 0.20 since its semantics are unclear".} = deprecated: "Deprecated since version 0.20 since its semantics are unclear".} =
## **Deprecated**: Deprecated since version 0.20 since its semantics are unclear
##
## Checks whether or not `s` is completely whitespace. ## Checks whether or not `s` is completely whitespace.
## ##
## Returns true if all characters in `s` are whitespace ## Returns true if all characters in `s` are whitespace
@ -3049,8 +3037,6 @@ template isCaseImpl(s, charProc, skipNonAlpha) =
proc isLowerAscii*(s: string, skipNonAlpha: bool): bool {. proc isLowerAscii*(s: string, skipNonAlpha: bool): bool {.
deprecated: "Deprecated since version 0.20 since its semantics are unclear".} = deprecated: "Deprecated since version 0.20 since its semantics are unclear".} =
## **Deprecated**: Deprecated since version 0.20 since its semantics are unclear
##
## Checks whether ``s`` is lower case. ## Checks whether ``s`` is lower case.
## ##
## This checks ASCII characters only. ## This checks ASCII characters only.
@ -3073,8 +3059,6 @@ proc isLowerAscii*(s: string, skipNonAlpha: bool): bool {.
proc isUpperAscii*(s: string, skipNonAlpha: bool): bool {. proc isUpperAscii*(s: string, skipNonAlpha: bool): bool {.
deprecated: "Deprecated since version 0.20 since its semantics are unclear".} = deprecated: "Deprecated since version 0.20 since its semantics are unclear".} =
## **Deprecated**: Deprecated since version 0.20 since its semantics are unclear
##
## Checks whether ``s`` is upper case. ## Checks whether ``s`` is upper case.
## ##
## This checks ASCII characters only. ## This checks ASCII characters only.
@ -3101,8 +3085,6 @@ proc wordWrap*(s: string, maxLineWidth = 80,
newLine = "\n"): string {. newLine = "\n"): string {.
noSideEffect, rtl, extern: "nsuWordWrap", noSideEffect, rtl, extern: "nsuWordWrap",
deprecated: "use wrapWords in std/wordwrap instead".} = deprecated: "use wrapWords in std/wordwrap instead".} =
## **Deprecated**: use wrapWords in std/wordwrap instead
##
## Word wraps `s`. ## Word wraps `s`.
result = newStringOfCap(s.len + s.len shr 6) result = newStringOfCap(s.len + s.len shr 6)
var spaceLeft = maxLineWidth var spaceLeft = maxLineWidth