]> granicus.if.org Git - python/commitdiff
Remove outdated bit of advice (584f9c213a6d follow-up)
authorÉric Araujo <merwok@netwok.org>
Tue, 7 Jun 2011 22:47:49 +0000 (00:47 +0200)
committerÉric Araujo <merwok@netwok.org>
Tue, 7 Jun 2011 22:47:49 +0000 (00:47 +0200)
Doc/documenting/markup.rst

index 57d9eeba14723cc9eadccd965f054cab2566be2b..c005d0c9e700799e8ec0937888b8111ac5443e93 100644 (file)
@@ -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: