From: Éric Araujo Date: Sat, 4 Jun 2011 16:35:04 +0000 (+0200) Subject: Remove outdated bit of advice (c882b5ff92d9 follow-up) X-Git-Tag: v2.7.3rc1~697^2~1 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3322a255320582d4ce67b14fe358adc4dc121db7;p=python Remove outdated bit of advice (c882b5ff92d9 follow-up) --- diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index 6db854539b..4f1fcae9e7 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: