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

Add doc for new doc field syntax.

Browse Source
This commit is contained in:
Georg Brandl 2010-01-17 19:05:19 +01:00
parent 206484ce07
commit 1a7403bed8
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/markup/desc.rst
View File

@ -245,6 +245,8 @@ Info field lists
.. versionadded:: 0.4
.. XXX this is only for Python
Inside object description directives, reST field lists with these fields are
recognized and formatted nicely:
@ -272,6 +274,11 @@ explained by an example::
:type limit: integer or None
:rtype: list of strings
It is also possible to combine parameter type and description, if the type is a
single word, like this::
:param integer limit: maximum number of stack frames to show
This will render like this:
.. function:: format_exception(etype, value, tb[, limit=None])