Georg Brandl avatar Georg Brandl committed 17ada3a

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

Comments (0)

Files changed (1)

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.
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.