summaryrefslogtreecommitdiffstats
path: root/Doc/documenting
diff options
context:
space:
mode:
authorÉric Araujo <merwok@netwok.org>2011-04-20 18:22:57 (GMT)
committerÉric Araujo <merwok@netwok.org>2011-04-20 18:22:57 (GMT)
commitab20b164b95fc9daaf5dbbb08bce6da2135d34ed (patch)
tree1cc3b189f247e9ba66073a18e9a4854e0c8afaa7 /Doc/documenting
parent64e564b8f5de1f1822f051f98d3b247bdd001f74 (diff)
parent37e6c54ba122703a0162dd44cf3eac78c46c8bdd (diff)
downloadcpython-ab20b164b95fc9daaf5dbbb08bce6da2135d34ed.zip
cpython-ab20b164b95fc9daaf5dbbb08bce6da2135d34ed.tar.gz
cpython-ab20b164b95fc9daaf5dbbb08bce6da2135d34ed.tar.bz2
Merge 3.2
Diffstat (limited to 'Doc/documenting')
-rw-r--r--Doc/documenting/markup.rst25
1 files changed, 21 insertions, 4 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst
index 277ca9f..1f5b1e3 100644
--- a/Doc/documenting/markup.rst
+++ b/Doc/documenting/markup.rst
@@ -152,7 +152,7 @@ The directives are:
Describes global data in a module, including both variables and values used
as "defined constants." Class and object attributes are not documented
- using this environment.
+ using this directive.
.. describe:: exception
@@ -165,7 +165,7 @@ The directives are:
parameters, enclosing optional parameters in brackets. Default values can be
given if it enhances clarity. For example::
- .. function:: Timer.repeat([repeat=3[, number=1000000]])
+ .. function:: repeat([repeat=3[, number=1000000]])
Object methods are not documented using this directive. Bound object methods
placed in the module namespace as part of the public interface of the module
@@ -217,13 +217,30 @@ The directives are:
Describes an object data attribute. The description should include
information about the type of the data to be expected and whether it may be
- changed directly.
+ changed directly. This directive should be nested in a class directive,
+ like in this example::
+
+ .. class:: Spam
+
+ Description of the class.
+
+ .. data:: ham
+
+ Description of the attribute.
+
+ If is also possible to document an attribute outside of a class directive,
+ for example if the documentation for different attributes and methods is
+ split in multiple sections. The class name should then be included
+ explicitly::
+
+ .. data:: Spam.eggs
.. describe:: method
Describes an object method. The parameters should not include the ``self``
parameter. The description should include similar information to that
- described for ``function``.
+ described for ``function``. This method should be nested in a class
+ method, like in the example above.
.. describe:: decoratormethod