[Python-checkins] cpython (3.2): Remove outdated bit of advice (584f9c213a6d follow-up)

[eric.araujo]

http://hg.python.org/cpython/rev/096d5e8a1a4c
changeset:   70721:096d5e8a1a4c
branch:      3.2
parent:      70700:0aa3064d1cef
user:        Éric Araujo <merwok at netwok.org>
date:        Wed Jun 08 00:47:49 2011 +0200
summary:
  Remove outdated bit of advice (584f9c213a6d follow-up)

files:
  Doc/documenting/markup.rst |  11 ++++++-----
  1 files changed, 6 insertions(+), 5 deletions(-)


diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst
--- a/Doc/documenting/markup.rst
+++ b/Doc/documenting/markup.rst
@@ -98,11 +98,12 @@
 
        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:

-- 
Repository URL: http://hg.python.org/cpython