mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2025-12-28 17:04:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

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
parent b4edfa613b
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.}
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*.
.. 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
{.deprecated: [TFile: File, PStream: Stream].}
noSideEffect pragma
-------------------
The ``noSideEffect`` pragma is used to mark a proc/iterator to have no side