Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit b8f2ad0

Browse files
committed
Remove outdated bit of advice (584f9c213a6d follow-up)
1 parent 41c1910 commit b8f2ad0

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

Doc/documenting/markup.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -98,11 +98,12 @@ following example shows all of the features of this directive type::
9898

9999
Spam or ham the foo.
100100

101-
The signatures of object methods or data attributes should always include the
102-
type name (``.. method:: FileInput.input(...)``), even if it is obvious from the
103-
context which type they belong to; this is to enable consistent
104-
cross-references. If you describe methods belonging to an abstract protocol,
105-
such as "context managers", include a (pseudo-)type name too to make the
101+
The signatures of object methods or data attributes should not include the
102+
class name, but be nested in a class directive. The generated files will
103+
reflect this nesting, and the target identifiers (for HTML output) will use
104+
both the class and method name, to enable consistent cross-references. If you
105+
describe methods belonging to an abstract protocol such as context managers,
106+
use a class directive with a (pseudo-)type name too to make the
106107
index entries more informative.
107108

108109
The directives are:

0 commit comments

Comments
 (0)