diff options
| -rw-r--r-- | contributing.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/contributing.rst b/contributing.rst index a952b8e74..5b86cf802 100644 --- a/contributing.rst +++ b/contributing.rst @@ -142,8 +142,8 @@ When contributing new procedures, be sure to add documentation, especially if the procedure is exported from the module. Documentation begins on the line following the ``proc`` definition, and is prefixed by ``##`` on each line. -Code examples are also encouraged. The RST syntax Nim uses has a special syntax -for including examples. +Code examples are also encouraged. The RestructuredText Nim uses has a special +syntax for including examples. .. code-block:: nim @@ -156,7 +156,7 @@ for including examples. result = "something" # single-hash comments do not produce documentation The ``.. code-block:: nim`` followed by a newline and an indentation instructs the -``nim doc`` and ``nim doc2`` commands to produce syntax-highlited example code with +``nim doc`` and ``nim doc2`` commands to produce syntax-highlighted example code with the documentation. When forward declaration is used, the documentation should be included with the |