diff options
| author | Éric Araujo <merwok@netwok.org> | 2011-06-09 14:28:19 (GMT) |
|---|---|---|
| committer | Éric Araujo <merwok@netwok.org> | 2011-06-09 14:28:19 (GMT) |
| commit | 577a6af8e6b715e6b46e92cf14603a266fc361a8 (patch) | |
| tree | 0e8dea141496acacce19f2805a14b979a6ca74af /Doc/documenting | |
| parent | f5949b5e4709ad6986aa1be79531198868227c1d (diff) | |
| parent | ebc991c0ce4493be276f2ea29676131b8880ec10 (diff) | |
| download | cpython-577a6af8e6b715e6b46e92cf14603a266fc361a8.zip cpython-577a6af8e6b715e6b46e92cf14603a266fc361a8.tar.gz cpython-577a6af8e6b715e6b46e92cf14603a266fc361a8.tar.bz2 | |
Merge doc fixes from 3.2
Diffstat (limited to 'Doc/documenting')
| -rw-r--r-- | Doc/documenting/markup.rst | 11 |
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: |