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

:func: et al. should not include parens.

Browse Source
This commit is contained in:
Georg Brandl 2008-04-19 17:00:31 +00:00
parent c177e6d05d
commit c5a4ebe008
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/markup/inline.rst
View File

@ -57,8 +57,9 @@ a matching identifier is found:
.. role:: func .. role:: func
The name of a Python function; dotted names may be used. The role text The name of a Python function; dotted names may be used. The role text
should include trailing parentheses to enhance readability. The parentheses needs not include trailing parentheses to enhance readability; they will be
are stripped when searching for identifiers. added automatically by Sphinx if the :confval:`add_function_parentheses`
config value is true (the default).
.. role:: data .. role:: data
@ -76,7 +77,8 @@ a matching identifier is found:
.. role:: meth .. role:: meth
The name of a method of an object. The role text should include the type The name of a method of an object. The role text should include the type
name, method name and the trailing parentheses. A dotted name may be used. name and the method name; if it occurs within the description of a type,
the type name can be omitted. A dotted name may be used.
.. role:: attr .. role:: attr