Commits

Georg Brandl committed 17ada3a

Make it clearer how autodoc special comments have to be formatted.

  • Participants
  • Parent commits 3e6a1ca
  • Branches stable

Comments (0)

Files changed (1)

File doc/ext/autodoc.rst

                    automethod
                    autoattribute
 
-   These work exactly like :rst:dir:`autoclass` etc., but do not offer the options
-   used for automatic member documentation.
+   These work exactly like :rst:dir:`autoclass` etc., but do not offer the
+   options used for automatic member documentation.
 
    For module data members and class attributes, documentation can either be put
-   into a special-formatted comment, or in a docstring *after* the definition.
-   Comments need to be either on a line of their own *before* the definition, or
+   into a comment with special formatting (using a ``#:`` to start the comment
+   instead of just ``#``), or in a docstring *after* the definition.  Comments
+   need to be either on a line of their own *before* the definition, or
    immediately after the assignment *on the same line*.  The latter form is
    restricted to one line only.