diff options
author | Georg Brandl <georg@python.org> | 2014-01-13 20:13:44 +0100 |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2014-01-13 20:13:44 +0100 |
commit | 9006c74ab6d9826ccac75fd7ad1da6419de9890b (patch) | |
tree | ae6631ee6213e395d77034b94ab09b4caf6f2860 | |
parent | a5f8d9e765946b2ebe33ba0eda2410a6a372bbf3 (diff) | |
download | sphinx-9006c74ab6d9826ccac75fd7ad1da6419de9890b.tar.gz |
More tweaks to the py domain docs.
-rw-r--r-- | doc/domains.rst | 33 |
1 files changed, 17 insertions, 16 deletions
diff --git a/doc/domains.rst b/doc/domains.rst index 024edc9a..6c3c4359 100644 --- a/doc/domains.rst +++ b/doc/domains.rst @@ -157,17 +157,6 @@ declarations: The following directives are provided for module and class contents: -.. rst:directive:: .. py:data:: name - - 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. - -.. rst:directive:: .. py:exception:: name - - Describes an exception class. The signature can, but need not include - parentheses with constructor arguments. - .. rst:directive:: .. py:function:: name(parameters) Describes a module-level function. The signature should include the @@ -178,11 +167,23 @@ The following directives are provided for module and class contents: For methods you should use :rst:dir:`py:method`. - The description should include information about the parameters required and - how they are used (especially whether mutable objects passed as parameters - are modified), side effects, and possible exceptions. This information can - optionally be given in a structured form, see :ref:`info-field-lists`. A - small example may be provided. + The description normally includes information about the parameters required + and how they are used (especially whether mutable objects passed as + parameters are modified), side effects, and possible exceptions. + + This information can (in any ``py`` directive) optionally be given in a + structured form, see :ref:`info-field-lists`. + +.. rst:directive:: .. py:data:: name + + 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. + +.. rst:directive:: .. py:exception:: name + + Describes an exception class. The signature can, but need not include + parentheses with constructor arguments. .. rst:directive:: .. py:class:: name .. py:class:: name(parameters) |