summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorGrzegorz Adam Hankiewicz <gradha@imap.cc>2013-12-12 01:00:23 +0100
committerGrzegorz Adam Hankiewicz <gradha@imap.cc>2013-12-12 01:00:23 +0100
commitb4d6a6aafe400556d3557cb7ccf0a12a40e1b4e7 (patch)
tree990de6393182d9d74812a6a89a75cda426c31505
parentc6c836692585b6a94f7c453bf1dff82be0107b2f (diff)
downloadNim-b4d6a6aafe400556d3557cb7ccf0a12a40e1b4e7.tar.gz
Adds example to fatal pragma.
-rw-r--r--doc/manual.txt6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/manual.txt b/doc/manual.txt
index dabff3d69..ee283da0c 100644
--- a/doc/manual.txt
+++ b/doc/manual.txt
@@ -4708,7 +4708,11 @@ fatal pragma
 ------------
 The `fatal`:idx: pragma is used to make the compiler output an error message
 with the given content. In contrast to the ``error`` pragma, compilation
-is guaranteed to be aborted by this pragma.
+is guaranteed to be aborted by this pragma. Example:
+
+.. code-block:: nimrod
+  when not defined(objc):
+    {.fatal: "Compile this program with the objc command!".}
 
 warning pragma
 --------------