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

#550: fix confusing example in docs.

Browse Source
This commit is contained in:
Georg Brandl
2010-11-12 08:26:20 +01:00
parent 33fb06bca6
commit 3e8834503f
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/domains.rst
View File

@@ -288,11 +288,6 @@ explained by an example::
:type limit: integer or None :type limit: integer or None
:rtype: list of strings :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: This will render like this:
.. py:function:: format_exception(etype, value, tb[, limit=None]) .. py:function:: format_exception(etype, value, tb[, limit=None])
@@ -307,6 +302,11 @@ This will render like this:
:type limit: integer or None :type limit: integer or None
:rtype: list of strings :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
Cross-referencing Python objects Cross-referencing Python objects
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~