diff options
| author | Grzegorz Adam Hankiewicz <gradha@imap.cc> | 2014-01-06 13:18:27 +0100 |
|---|---|---|
| committer | Grzegorz Adam Hankiewicz <gradha@imap.cc> | 2014-01-06 13:18:27 +0100 |
| commit | 0b6c9d7d75db7b3a9b93c465ba8a99c559fc305c (patch) | |
| tree | c0772eb47e4b6f227017ead6b3ce5015c2408960 /doc | |
| parent | e0fc07df89a2bc9a9472b08c4003be7b2ff6498b (diff) | |
| download | Nim-0b6c9d7d75db7b3a9b93c465ba8a99c559fc305c.tar.gz | |
Fixes two minor typos.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/docgen.txt | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/docgen.txt b/doc/docgen.txt index 998cde839..e287e4825 100644 --- a/doc/docgen.txt +++ b/doc/docgen.txt @@ -13,14 +13,14 @@ Introduction This document describes the documentation generation tools built into the *Nimrod compiler*, which can generate HTML and JSON output from input .nim files and projects, as well as HTML -and LaTex from input RST (reStructuredText) files. The output documentation will include +and LaTeX from input RST (reStructuredText) files. The output documentation will include module dependencies (``import``), any top-level documentation comments (##), and exported symbols (*), including procedures, types, and variables. Documentation Comments ---------------------- -Any comments which are preceeded by a double-hash (##), are interpreted as documentation. +Any comments which are preceded by a double-hash (##), are interpreted as documentation. Comments are parsed as RST (see `reference <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_), providing Nimrod module authors the ability to easily generate richly formatted documentation with only |