[Python-checkins] r63558 - doctools/trunk/doc/ext/autodoc.rst

[georg.brandl]

Author: georg.brandl
Date: Fri May 23 15:57:48 2008
New Revision: 63558

Log:
Clarify docs for auto directive options.


Modified:
   doctools/trunk/doc/ext/autodoc.rst

Modified: doctools/trunk/doc/ext/autodoc.rst
==============================================================================
--- doctools/trunk/doc/ext/autodoc.rst	(original)
+++ doctools/trunk/doc/ext/autodoc.rst	Fri May 23 15:57:48 2008
@@ -61,17 +61,31 @@
    will document exactly the specified members.
 
    Members without docstrings will be left out, unless you give the
-   ``undoc-members`` flag option.
+   ``undoc-members`` flag option::
+
+      .. autoclass:: Noodle
+         :members:
+         :undoc-members:
 
    .. versionadded:: 0.3
       For classes and exceptions, members inherited from base classes will be
-      left out, unless you give the ``inherited-members`` flag option.
+      left out, unless you give the ``inherited-members`` flag option, in
+      addition to ``members``:
+
+   ::
+
+      .. autoclass:: Noodle
+         :members:
+         :inherited-members:
+
+   This can be combined with ``undoc-members`` to document *all* available
+   members of the class or module.
 
    .. versionadded:: 0.4
       It's possible to override the signature for callable members (functions,
       methods, classes) with the regular syntax that will override the signature
       gained from instropection:
-      
+
    ::
 
       .. autoclass:: Noodle(type)