diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2020-02-24 17:30:34 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-24 17:30:34 -0500 |
| commit | d25fd7146131688e934290a3c5bf0407e904dbb2 (patch) | |
| tree | 5fd4b905157eafbf3ea0071bfd625763b109ee78 /cmd2/constants.py | |
| parent | fea1bc15f4a53aa72d16c2985377fe3987b6b348 (diff) | |
| parent | 803f71a04d7f7290ca1390a164808679f5943178 (diff) | |
| download | cmd2-git-d25fd7146131688e934290a3c5bf0407e904dbb2.tar.gz | |
Merge pull request #899 from python-cmd2/api_docs
API documentation
Diffstat (limited to 'cmd2/constants.py')
| -rw-r--r-- | cmd2/constants.py | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/cmd2/constants.py b/cmd2/constants.py index bc72817f..d7e52cc9 100644 --- a/cmd2/constants.py +++ b/cmd2/constants.py @@ -1,6 +1,10 @@ # # coding=utf-8 -"""Constants and definitions""" +"""This module contains constants used throughout ``cmd2``.""" + +# Unless documented in https://cmd2.readthedocs.io/en/latest/api/index.html +# nothing here should be considered part of the public API of this module + # Used for command parsing, output redirection, tab completion and word # breaks. Do not change. @@ -32,9 +36,9 @@ HELP_FUNC_PREFIX = 'help_' # All command completer functions start with this COMPLETER_FUNC_PREFIX = 'complete_' -############################################################################################################ +############################################################################## # The following are optional attributes added to do_* command functions -############################################################################################################ +############################################################################## # The custom help category a command belongs to CMD_ATTR_HELP_CATEGORY = 'help_category' |