summaryrefslogtreecommitdiff
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
parente23e010f013b7384cb79450258778bc63d64832a (diff)
downloadcmd2-git-0ddf61a2b8640d38b182be9100f35350cb2c96f8.tar.gz
Consistently use :raises: instead of :raises (make sure there is a trailing colon)
-rw-r--r--cmd2/ansi.py4
-rw-r--r--cmd2/argparse_custom.py2
-rw-r--r--cmd2/cmd2.py6
3 files changed, 6 insertions, 6 deletions
diff --git a/cmd2/ansi.py b/cmd2/ansi.py
index ceb135ec..a6c09413 100644
--- a/cmd2/ansi.py
+++ b/cmd2/ansi.py
@@ -196,7 +196,7 @@ def fg_lookup(fg_name: Union[str, fg]) -> str:
:param fg_name: foreground color name or enum to look up ANSI escape code(s) for
:return: ANSI escape code(s) associated with this color
- :raises ValueError: if the color cannot be found
+ :raises: ValueError: if the color cannot be found
"""
if isinstance(fg_name, fg):
return fg_name.value
@@ -214,7 +214,7 @@ def bg_lookup(bg_name: Union[str, bg]) -> str:
:param bg_name: background color name or enum to look up ANSI escape code(s) for
:return: ANSI escape code(s) associated with this color
- :raises ValueError: if the color cannot be found
+ :raises: ValueError: if the color cannot be found
"""
if isinstance(bg_name, bg):
return bg_name.value
diff --git a/cmd2/argparse_custom.py b/cmd2/argparse_custom.py
index d6833673..c24d8d9a 100644
--- a/cmd2/argparse_custom.py
+++ b/cmd2/argparse_custom.py
@@ -387,7 +387,7 @@ def _add_argument_wrapper(self, *args,
See the header of this file for more information
:return: the created argument action
- :raises ValueError on incorrect parameter usage
+ :raises: ValueError on incorrect parameter usage
"""
# Verify consistent use of arguments
choices_callables = [choices_function, choices_method, completer_function, completer_method]
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.")