summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorÉric Araujo <merwok@netwok.org>2011-06-07 22:47:49 (GMT)
committerÉric Araujo <merwok@netwok.org>2011-06-07 22:47:49 (GMT)
commitb8f2ad03805048f43723019aecbcf181fbf01549 (patch)
treed5b193aa6004fffe7eba2aae160743c2a8531efa
parent41c1910bb3229874a02c19ecd9189715b3ce501b (diff)
downloadcpython-b8f2ad03805048f43723019aecbcf181fbf01549.zip
cpython-b8f2ad03805048f43723019aecbcf181fbf01549.tar.gz
cpython-b8f2ad03805048f43723019aecbcf181fbf01549.tar.bz2
Remove outdated bit of advice (584f9c213a6d follow-up)
-rw-r--r--Doc/documenting/markup.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst
index 57d9eeb..c005d0c 100644
--- a/Doc/documenting/markup.rst
+++ b/Doc/documenting/markup.rst
@@ -98,11 +98,12 @@ following example shows all of the features of this directive type::
Spam or ham the foo.
-The signatures of object methods or data attributes should always include the
-type name (``.. method:: FileInput.input(...)``), even if it is obvious from the
-context which type they belong to; this is to enable consistent
-cross-references. If you describe methods belonging to an abstract protocol,
-such as "context managers", include a (pseudo-)type name too to make the
+The signatures of object methods or data attributes should not include the
+class name, but be nested in a class directive. The generated files will
+reflect this nesting, and the target identifiers (for HTML output) will use
+both the class and method name, to enable consistent cross-references. If you
+describe methods belonging to an abstract protocol such as context managers,
+use a class directive with a (pseudo-)type name too to make the
index entries more informative.
The directives are: