mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-01 04:42:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Remove outdated bit of advice (c882b5ff92d9 follow-up)

Browse source
This commit is contained in:
Éric Araujo 2011-06-04 18:35:04 +02:00
parent 7d21401811
commit 3322a25532
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Doc/documenting/markup.rst
View file

@ -98,11 +98,12 @@ following example shows all of the features of this directive type::
Spam or ham the foo. Spam or ham the foo.
The signatures of object methods or data attributes should always include the The signatures of object methods or data attributes should not include the
type name (``.. method:: FileInput.input(...)``), even if it is obvious from the class name, but be nested in a class directive. The generated files will
context which type they belong to; this is to enable consistent reflect this nesting, and the target identifiers (for HTML output) will use
cross-references. If you describe methods belonging to an abstract protocol, both the class and method name, to enable consistent cross-references. If you
such as "context managers", include a (pseudo-)type name too to make the 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. index entries more informative.
The directives are: The directives are: