jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added to docs: warning string for {.deprecated.} pragma (#8783)

Browse source
This commit is contained in:
awr1 2018-08-26 10:42:57 -05:00 • committed by Andreas Rumpf
commit 50aa376e80
1 changed files with 5 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
doc/manual.rst
View file

@ -6448,6 +6448,11 @@ The deprecated pragma is used to mark a symbol as deprecated:
proc p() {.deprecated.} proc p() {.deprecated.}
var x {.deprecated.}: char var x {.deprecated.}: char
This pragma can also take in an optional warning string to relay to developers.
.. code-block:: nim
proc thing(x: bool) {.deprecated: "See arguments of otherThing()".}
It can also be used as a statement, in that case it takes a list of *renamings*. It can also be used as a statement, in that case it takes a list of *renamings*.
.. code-block:: nim .. code-block:: nim
@ -6456,7 +6461,6 @@ It can also be used as a statement, in that case it takes a list of *renamings*.
Stream = ref object Stream = ref object
{.deprecated: [TFile: File, PStream: Stream].} {.deprecated: [TFile: File, PStream: Stream].}
noSideEffect pragma noSideEffect pragma
------------------- -------------------
The ``noSideEffect`` pragma is used to mark a proc/iterator to have no side The ``noSideEffect`` pragma is used to mark a proc/iterator to have no side