diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/doc_conventions.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/doc_conventions.rst b/docs/doc_conventions.rst index 0b44f096..9b714d45 100644 --- a/docs/doc_conventions.rst +++ b/docs/doc_conventions.rst @@ -155,9 +155,9 @@ See ``cmd2/docs/api/cmd.rst`` to see how to add documentation for an attribute. For module data members and class attributes, the ``autodoc`` extension allows documentation in a comment with special formatting (using a #: to start the -comment instead of just #), or in a docstring after the definition. This project -has standardized on the docstring after the definition approach. Do not use the -specially formatted comment approach. +comment instead of just #), or in a docstring after the definition. This +project has standardized on the docstring after the definition approach. Do not +use the specially formatted comment approach. Links to API Reference |