diff options
author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2020-02-06 23:30:33 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-02-06 23:30:33 -0500 |
commit | 3c627af7c1e22bcd0cd0a49dee05fd6b626bccc5 (patch) | |
tree | ba04d09ce9d0df114890db8e31dd6cb6988f9d7b /docs/doc_conventions.rst | |
parent | c7ac2e965d025806ce5baddfc718814e3e58d639 (diff) | |
parent | 90152df53478a00a3c64ba5ece160485408680dd (diff) | |
download | cmd2-git-3c627af7c1e22bcd0cd0a49dee05fd6b626bccc5.tar.gz |
Merge pull request #875 from python-cmd2/doc_streamline
Doc streamline
Diffstat (limited to 'docs/doc_conventions.rst')
-rw-r--r-- | docs/doc_conventions.rst | 16 |
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:: |