summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKevin "Tristate Tom" Weiss <weiss.kevin604@gmail.com>2021-01-28 13:51:44 +0100
committerGitHub <noreply@github.com>2021-01-28 13:51:44 +0100
commita09ad27429e9bad2983db7f3ba4e7ab287459cab (patch)
tree0f209d0b86f1a0288b9e78789a00b4a608224979 /docs
parent44eb9d4e1946a3cc9a10fe85ccb617b6076f627c (diff)
downloadcmd2-git-a09ad27429e9bad2983db7f3ba4e7ab287459cab.tar.gz
Fix doc in docs/features/commands.rst
finis should be finish. A missing double quote (") for the docstring in the `do_bail` example makes formatting incorrect.
Diffstat (limited to 'docs')
-rw-r--r--docs/features/commands.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/features/commands.rst b/docs/features/commands.rst
index 8e61a472..cc603f70 100644
--- a/docs/features/commands.rst
+++ b/docs/features/commands.rst
@@ -127,7 +127,7 @@ without errors), and that ``cmd2`` should prompt the user for more input.
If you return ``True`` from a command method, that indicates to ``cmd2`` that
it should stop prompting for user input and cleanly exit. ``cmd2`` already
includes a ``quit`` command, but if you wanted to make another one called
-``finis`` you could::
+``finish`` you could::
def do_finish(self, line):
"""Exit the application"""
@@ -156,7 +156,7 @@ system shell::
"""A simple cmd2 application."""
def do_bail(self, line):
- """Exit the application""
+ """Exit the application"""
self.perror("fatal error, exiting")
self.exit_code = 2
return true