summary refs log tree commit diff stats
path: root/lib
diff options
context:
space:
mode:
authornarimiran <narimiran@disroot.org>2019-06-19 14:21:46 +0200
committernarimiran <narimiran@disroot.org>2019-06-19 14:21:46 +0200
commitcf47c2c60c103eb9add42a306169381d25283aa2 (patch)
tree22fd3e20c50ecda65db81bd8412959684f85fda3 /lib
parent24ac13f653177bda9cc0b7aa7795acc7cee62c8d (diff)
downloadNim-cf47c2c60c103eb9add42a306169381d25283aa2.tar.gz
[other] documentation: deprecation comments are now auto-generated
Diffstat (limited to 'lib')
-rw-r--r--lib/pure/collections/sequtils.nim4
-rw-r--r--lib/pure/strutils.nim18
2 files changed, 1 insertions, 21 deletions
diff --git a/lib/pure/collections/sequtils.nim b/lib/pure/collections/sequtils.nim
index d451b8ecf..de100ead4 100644
--- a/lib/pure/collections/sequtils.nim
+++ b/lib/pure/collections/sequtils.nim
@@ -847,9 +847,7 @@ template mapIt*(s: typed, op: untyped): untyped =
     result
 
 template mapIt*(s, typ, op: untyped): untyped {.error:
-  "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.
+  "Deprecated since v0.12; Use 'mapIt(seq1, op)' - without specifying the type of the returned seqence".} =
   var result: seq[typ] = @[]
   for it {.inject.} in items(s):
     result.add(op)
diff --git a/lib/pure/strutils.nim b/lib/pure/strutils.nim
index 96468e4af..c5cc25625 100644
--- a/lib/pure/strutils.nim
+++ b/lib/pure/strutils.nim
@@ -2856,8 +2856,6 @@ iterator tokenize*(s: string, seps: set[char] = Whitespace): tuple[
 proc editDistance*(a, b: string): int {.noSideEffect,
   rtl, extern: "nsuEditDistance",
   deprecated: "use editdistance.editDistanceAscii instead".} =
-  ## **Deprecated**: Use `editdistance module<editdistance.html>`_
-  ##
   ## Returns the edit distance between `a` and `b`.
   ##
   ## 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,
                                       extern: "nsuIsNilOrEmpty",
                                       deprecated: "use 'x.len == 0' instead".} =
-  ## **Deprecated**: use 'x.len == 0'
-  ##
   ## Checks if `s` is nil or empty.
   result = len(s) == 0
 
@@ -2969,8 +2965,6 @@ template isImpl(call) =
 proc isAlphaAscii*(s: string): bool {.noSideEffect, procvar,
   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
-  ##
   ## Checks whether or not `s` is alphabetical.
   ##
   ## 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,
   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
-  ##
   ## Checks whether or not `s` is alphanumeric.
   ##
   ## 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,
   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
-  ##
   ## Checks whether or not `s` is a numeric value.
   ##
   ## 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,
   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
-  ##
   ## Checks whether or not `s` is completely 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 {.
   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.
   ##
   ## This checks ASCII characters only.
@@ -3073,8 +3059,6 @@ proc isLowerAscii*(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
-  ##
   ## Checks whether ``s`` is upper case.
   ##
   ## This checks ASCII characters only.
@@ -3101,8 +3085,6 @@ proc wordWrap*(s: string, maxLineWidth = 80,
                newLine = "\n"): string {.
                noSideEffect, rtl, extern: "nsuWordWrap",
                deprecated: "use wrapWords in std/wordwrap instead".} =
-  ## **Deprecated**: use wrapWords in std/wordwrap instead
-  ##
   ## Word wraps `s`.
   result = newStringOfCap(s.len + s.len shr 6)
   var spaceLeft = maxLineWidth