diff options
Diffstat (limited to 'doc/manual/pragmas.txt')
| -rw-r--r-- | doc/manual/pragmas.txt | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/manual/pragmas.txt b/doc/manual/pragmas.txt index 1a19cb129..6181b3e1b 100644 --- a/doc/manual/pragmas.txt +++ b/doc/manual/pragmas.txt @@ -9,6 +9,26 @@ first implementation to play with a language feature before a nicer syntax to access the feature becomes available. +deprecated pragma +----------------- + +The deprecated pragma is used to mark a symbol as deprecated: + +.. code-block:: nimrod + proc p() {.deprecated.} + var x {.deprecated.}: char + +It can also be used as a statement. Then it takes a list of *renamings*. The +upcoming ``nimfix`` tool can automatically update the code and perform these +renamings: + +.. code-block:: nimrod + type + File = object + Stream = ref object + {.deprecated: [TFile: File, PStream: Stream].} + + noSideEffect pragma ------------------- The ``noSideEffect`` pragma is used to mark a proc/iterator to have no side |