summaryrefslogtreecommitdiff
path: root/cmd2/cmd2.py
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2020-04-20 21:56:19 -0400
committerTodd Leonhardt <todd.leonhardt@gmail.com>2020-04-20 21:56:19 -0400
commit0ddf61a2b8640d38b182be9100f35350cb2c96f8 (patch)
tree24d36dae7d573708b226c7808368205076811147 /cmd2/cmd2.py
parente23e010f013b7384cb79450258778bc63d64832a (diff)
downloadcmd2-git-0ddf61a2b8640d38b182be9100f35350cb2c96f8.tar.gz
Consistently use :raises: instead of :raises (make sure there is a trailing colon)
Diffstat (limited to 'cmd2/cmd2.py')
-rw-r--r--cmd2/cmd2.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py
index 6dbe6d90..99ddffa3 100644
--- a/cmd2/cmd2.py
+++ b/cmd2/cmd2.py
@@ -1897,7 +1897,7 @@ class Cmd(cmd.Cmd):
:param statement: a parsed statement from the user
:return: A bool telling if an error occurred and a utils.RedirectionSavedState object
- :raises RedirectionError if an error occurs trying to pipe or redirect
+ :raises: RedirectionError if an error occurs trying to pipe or redirect
"""
import io
import subprocess
@@ -2178,7 +2178,7 @@ class Cmd(cmd.Cmd):
:param prompt: prompt to display to user
:return: command line text of 'eof' if an EOFError was caught
- :raises whatever exceptions are raised by input() except for EOFError
+ :raises: whatever exceptions are raised by input() except for EOFError
"""
try:
# Wrap in try since terminal_lock may not be locked
@@ -3701,7 +3701,7 @@ class Cmd(cmd.Cmd):
Run a text editor and optionally open a file with it
:param file_path: optional path of the file to edit
- :raises EnvironmentError if self.editor is not set
+ :raises: EnvironmentError if self.editor is not set
"""
if not self.editor:
raise EnvironmentError("Please use 'set editor' to specify your text editing program of choice.")