diff options
| author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2021-03-31 14:53:50 -0400 |
|---|---|---|
| committer | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2021-03-31 15:34:37 -0400 |
| commit | 06f05261945d706b668c8021a7ae6f8dcd15b9ea (patch) | |
| tree | 26839ea0e5e4527a795336e6bdbec3a3fa4730b7 /docs | |
| parent | 5165edec890575682f345fc42f5a53e10ed575b9 (diff) | |
| download | cmd2-git-error_cleanup.tar.gz | |
Replaced some pexcept() calls with perror().error_cleanup
Converted some strings to f-strings.
Fixed some grammar in error messages and docs.
Increased code coverage.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/index.rst | 2 | ||||
| -rw-r--r-- | docs/features/argument_processing.rst | 4 | ||||
| -rw-r--r-- | docs/features/hooks.rst | 2 |
3 files changed, 4 insertions, 4 deletions
diff --git a/docs/api/index.rst b/docs/api/index.rst index 861c3f97..1f5e1625 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -5,7 +5,7 @@ These pages document the public API for ``cmd2``. If a method, class, function, attribute, or constant is not documented here, consider it private and subject to change. There are many classes, methods, functions, and constants in the source code which do not begin with an underscore but are not documented here. -When looking at the source code for this library, you can not safely assume +When looking at the source code for this library, you cannot safely assume that because something doesn't start with an underscore, it is a public API. If a release of this library changes any of the items documented here, the diff --git a/docs/features/argument_processing.rst b/docs/features/argument_processing.rst index bcc68633..9a78d720 100644 --- a/docs/features/argument_processing.rst +++ b/docs/features/argument_processing.rst @@ -170,7 +170,7 @@ To add additional text to the end of the generated help message, use the ``epilo from cmd2 import with_argparser argparser = argparse.ArgumentParser(description='create an html tag', - epilog='This command can not generate tags with no content, like <br/>.') + epilog='This command cannot generate tags with no content, like <br/>.') argparser.add_argument('tag', help='tag') argparser.add_argument('content', nargs='+', help='content to surround with tag') @with_argparser(argparser) @@ -193,7 +193,7 @@ Which yields: optional arguments: -h, --help show this help message and exit - This command can not generate tags with no content, like <br/> + This command cannot generate tags with no content, like <br/> .. warning:: diff --git a/docs/features/hooks.rst b/docs/features/hooks.rst index acf9dcc4..881b4e7e 100644 --- a/docs/features/hooks.rst +++ b/docs/features/hooks.rst @@ -207,7 +207,7 @@ with the :data:`~cmd2.plugin.PostparsingData.stop` attribute set to ``True``: Precommand Hooks ---------------- -Precommand hooks can modify the user input, but can not request the application +Precommand hooks can modify the user input, but cannot request the application terminate. If your hook needs to be able to exit the application, you should implement it as a postparsing hook. |