diff options
author | kotfu <kotfu@kotfu.net> | 2020-02-05 22:31:18 -0700 |
---|---|---|
committer | kotfu <kotfu@kotfu.net> | 2020-02-05 22:31:18 -0700 |
commit | bf3dc169c047acda1c1cf505e8cd0e9e46d4b4cf (patch) | |
tree | e4542578e14c2274dbc7e60271faa163d535007e /docs/features/builtin_commands.rst | |
parent | 60a212c1c585f0c4c06ffcfeb9882520af8dbf35 (diff) | |
download | cmd2-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/features/builtin_commands.rst')
-rw-r--r-- | docs/features/builtin_commands.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/features/builtin_commands.rst b/docs/features/builtin_commands.rst index 025149b3..d2cefa71 100644 --- a/docs/features/builtin_commands.rst +++ b/docs/features/builtin_commands.rst @@ -1,7 +1,7 @@ Builtin Commands ================ -Applications which subclass :class:`cmd2.cmd2.Cmd` inherit a number of commands +Applications which subclass :class:`cmd2.Cmd` inherit a number of commands which may be useful to your users. Developers can :ref:`features/builtin_commands:Remove Builtin Commands` if they do not want them to be part of the application. @@ -130,9 +130,9 @@ This command lists available shortcuts. See Remove Builtin Commands ----------------------- -Developers may not want to offer the commands builtin to :class:`cmd2.cmd2.Cmd` +Developers may not want to offer the commands builtin to :class:`cmd2.Cmd` to users of their application. To remove a command you must delete the method -implementing that command from the :class:`cmd2.cmd2.Cmd` object at runtime. +implementing that command from the :class:`cmd2.Cmd` object at runtime. For example, if you wanted to remove the :ref:`features/builtin_commands:shell` command from your application:: |