summaryrefslogtreecommitdiffstats
path: root/Doc/documenting
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2008-04-19 17:00:14 (GMT)
committerGeorg Brandl <georg@python.org>2008-04-19 17:00:14 (GMT)
commitc7bef374029a69719d8ba7f7d5ed9b056b2d0457 (patch)
tree8a4fcc0296c58d0b544cc8291057511fe1300f25 /Doc/documenting
parent2fb8a53645e46cf9ab19b1e6c15c6666771c7905 (diff)
downloadcpython-c7bef374029a69719d8ba7f7d5ed9b056b2d0457.zip
cpython-c7bef374029a69719d8ba7f7d5ed9b056b2d0457.tar.gz
cpython-c7bef374029a69719d8ba7f7d5ed9b056b2d0457.tar.bz2
:func: et al. should *not* include the parens.
Diffstat (limited to 'Doc/documenting')
-rw-r--r--Doc/documenting/markup.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst
index f3a8237..7cf89b0 100644
--- a/Doc/documenting/markup.rst
+++ b/Doc/documenting/markup.rst
@@ -319,8 +319,8 @@ a matching identifier is found:
.. describe:: func
The name of a Python function; dotted names may be used. The role text
- should include trailing parentheses to enhance readability. The parentheses
- are stripped when searching for identifiers.
+ should not include trailing parentheses to enhance readability. The
+ parentheses are stripped when searching for identifiers.
.. describe:: data
@@ -338,7 +338,7 @@ a matching identifier is found:
.. describe:: meth
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. A dotted name may be used.
.. describe:: attr