Commit 89a751ca authored by Manuel Günther's avatar Manuel Günther
Browse files

Updated README (small RST issue).

parent 45a9f78f
......@@ -188,7 +188,7 @@ a) ``description.name()`` to get the name of the function
b) ``description.doc()`` to get the aligned documentation of the function, properly indented and broken at 80 characters (by default).
This call will check that all parameters and return values are documented, and add a ``.. todo`` directive if not.
Sphinx directives like ``.. note::``, ``.. warning::`` or ``.. math::`` will be automatically detected and aligned, when they are used as one-line directive, e.g.:
Sphinx directives like ``.. note::``, ``.. warning::`` or ``.. math::`` will be automatically detected and aligned, when they are used as one-line directive, e.g.::
"(more text)\n.. note:: This is a note\n(more text)"
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment