diff options
author | Araq <rumpf_a@web.de> | 2014-10-11 13:20:00 +0200 |
---|---|---|
committer | Araq <rumpf_a@web.de> | 2014-10-11 13:20:00 +0200 |
commit | 028a62e2bae3944a489904ae2d926408fc3f46ec (patch) | |
tree | b63d124b0ed457cb9ffb33ac63cbc2f6687907cd /doc | |
parent | 753d18d66c978b192b5c4fcf9b86c755c3fa9266 (diff) | |
download | Nim-028a62e2bae3944a489904ae2d926408fc3f46ec.tar.gz |
documentation updates
Diffstat (limited to 'doc')
-rw-r--r-- | doc/manual.txt | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/manual.txt b/doc/manual.txt index 7b713bf93..6aed72ce7 100644 --- a/doc/manual.txt +++ b/doc/manual.txt @@ -5039,6 +5039,27 @@ 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 |