summaryrefslogtreecommitdiff
path: root/docs/doc_conventions.rst
diff options
context:
space:
mode:
authorkotfu <kotfu@kotfu.net>2020-02-05 22:31:18 -0700
committerkotfu <kotfu@kotfu.net>2020-02-05 22:31:18 -0700
commitbf3dc169c047acda1c1cf505e8cd0e9e46d4b4cf (patch)
treee4542578e14c2274dbc7e60271faa163d535007e /docs/doc_conventions.rst
parent60a212c1c585f0c4c06ffcfeb9882520af8dbf35 (diff)
downloadcmd2-git-bf3dc169c047acda1c1cf505e8cd0e9e46d4b4cf.tar.gz
Clean up class and method references
- In docs/api/cmd.rst, the `cmd2.Cmd` class was defined as `cmd2.cmd2.Cmd`, which required the extraneous `cmd2` every time we referenced it. This extra `cmd2` is no longer required. - always refer to a bare cmd2 using ``cmd2`` per our documentation conventions
Diffstat (limited to 'docs/doc_conventions.rst')
-rw-r--r--docs/doc_conventions.rst16
1 files changed, 4 insertions, 12 deletions
diff --git a/docs/doc_conventions.rst b/docs/doc_conventions.rst
index 9b714d45..49149d7c 100644
--- a/docs/doc_conventions.rst
+++ b/docs/doc_conventions.rst
@@ -167,28 +167,20 @@ To reference a method or function, use one of the following approaches:
1. Reference the full dotted path of the method::
- The :meth:`cmd2.cmd2.Cmd.poutput` method is similar to the Python built-in
+ The :meth:`cmd2.Cmd.poutput` method is similar to the Python built-in
print function.
-Which renders as: The :meth:`cmd2.cmd2.Cmd.poutput` method is similar to the
+Which renders as: The :meth:`cmd2.Cmd.poutput` method is similar to the
Python built-in print function.
2. Reference the full dotted path to the method, but only display the method
name::
- The :meth:`~cmd2.cmd2.Cmd.poutput` method is similar to the Python built-in print function.
+ The :meth:`~cmd2.Cmd.poutput` method is similar to the Python built-in print function.
-Which renders as: The :meth:`~cmd2.cmd2.Cmd.poutput` method is similar to the
+Which renders as: The :meth:`~cmd2.Cmd.poutput` method is similar to the
Python built-in print function.
-3. Reference a portion of the dotted path of the method::
-
- The :meth:`.cmd2.Cmd.poutput` method is similar to the Python built-in print
- function.
-
-Which renders as: The :meth:`.cmd2.Cmd.poutput` method is similar to the Python
-built-in print function.
-
Avoid either of these approaches:
1. Reference just the class name without enough dotted path::