diff options
| -rw-r--r-- | doc/manual.rst | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/manual.rst b/doc/manual.rst index 19a5355a2..739f464e0 100644 --- a/doc/manual.rst +++ b/doc/manual.rst @@ -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 |