jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarified and fixed typo

Browse source
This commit is contained in:
apense 2015-07-01 13:00:01 -04:00
commit 13dd7922aa
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
contributing.rst
View file

@ -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 the procedure is exported from the module. Documentation begins on the line
following the ``proc`` definition, and is prefixed by ``##`` on each 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 Code examples are also encouraged. The RestructuredText Nim uses has a special
for including examples. syntax for including examples.
.. code-block:: nim .. code-block:: nim
@ -156,7 +156,7 @@ for including examples.
result = "something" # single-hash comments do not produce documentation result = "something" # single-hash comments do not produce documentation
The ``.. code-block:: nim`` followed by a newline and an indentation instructs the 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. the documentation.
When forward declaration is used, the documentation should be included with the When forward declaration is used, the documentation should be included with the