From 3322a255320582d4ce67b14fe358adc4dc121db7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Sat, 4 Jun 2011 18:35:04 +0200 Subject: [PATCH 1/2] Remove outdated bit of advice (c882b5ff92d9 follow-up) --- Doc/documenting/markup.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index 6db854539bd..4f1fcae9e75 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: From 865b573c044f0e2679b3ec61d14491e682329941 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Sat, 4 Jun 2011 20:45:33 +0200 Subject: [PATCH 2/2] Remove unnecessary executable bit on one distutils file --- Lib/distutils/tests/Setup.sample | 0 1 file changed, 0 insertions(+), 0 deletions(-) mode change 100755 => 100644 Lib/distutils/tests/Setup.sample diff --git a/Lib/distutils/tests/Setup.sample b/Lib/distutils/tests/Setup.sample old mode 100755 new mode 100644