IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Clarify example.

Browse Source
This commit is contained in:
Georg Brandl 2010-08-19 00:02:26 +02:00
parent 9cc47218b6
commit 9d7b75aa5d
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/rest.rst
View File

@ -325,14 +325,15 @@ directives.) Looking at this example, ::
.. function:: foo(x) .. function:: foo(x)
foo(y, z) foo(y, z)
:bar: no :module: some.module.name
Return a line of text input from the user. Return a line of text input from the user.
``function`` is the directive name. It is given two arguments here, the ``function`` is the directive name. It is given two arguments here, the
remainder of the first line and the second line, as well as one option ``bar`` remainder of the first line and the second line, as well as one option
(as you can see, options are given in the lines immediately following the ``module`` (as you can see, options are given in the lines immediately following
arguments and indicated by the colons). the arguments and indicated by the colons). Options must be indented to the
same level as the directive content.
The directive content follows after a blank line and is indented relative to the The directive content follows after a blank line and is indented relative to the
directive start. directive start.