summaryrefslogtreecommitdiff
path: root/cmd2
diff options
context:
space:
mode:
authorkotfu <kotfu@kotfu.net>2020-02-24 21:53:56 -0700
committerkotfu <kotfu@kotfu.net>2020-02-24 21:53:56 -0700
commit3b3c97d1083af07320ee1f8fd1618bd0c2682079 (patch)
tree8c0aef05194d8a9ba339771662a909774029255c /cmd2
parent654e8981ac1b58c4029e556c65f2ca889275ba44 (diff)
downloadcmd2-git-3b3c97d1083af07320ee1f8fd1618bd0c2682079.tar.gz
standardize language on ‘ansi style sequences’
Diffstat (limited to 'cmd2')
-rw-r--r--cmd2/ansi.py18
1 files changed, 9 insertions, 9 deletions
diff --git a/cmd2/ansi.py b/cmd2/ansi.py
index 27c9e87a..91e539f8 100644
--- a/cmd2/ansi.py
+++ b/cmd2/ansi.py
@@ -18,29 +18,29 @@ colorama.init(strip=False)
# Values for allow_style setting
STYLE_NEVER = 'Never'
"""
-Constant for ``cmd2.ansi.allow_style`` to indicate ANSI sequences
-should be removed from all output.
+Constant for ``cmd2.ansi.allow_style`` to indicate ANSI style sequences should
+be removed from all output.
"""
STYLE_TERMINAL = 'Terminal'
"""
-Constant for ``cmd2.ansi.allow_style`` to indicate ANSI sequences
+Constant for ``cmd2.ansi.allow_style`` to indicate ANSI style sequences
should be removed if the output is not going to the terminal.
"""
STYLE_ALWAYS = 'Always'
"""
-Constant for ``cmd2.ansi.allow_style`` to indicate ANSI sequences
-should alwyas be output.
+Constant for ``cmd2.ansi.allow_style`` to indicate ANSI style sequences should
+always be output.
"""
# Controls when ANSI style style sequences are allowed in output
allow_style = STYLE_TERMINAL
"""When using outside of a cmd2 app, set this variable to one of:
-- ``STYLE_NEVER`` - remove ANSI sequences from all output
-- ``STYLE_TERMINAL`` - remove ANSI sequences if the output is not going to the terminal
-- ``STYLE_ALWAYS`` - always output ANSI sequences
+- ``STYLE_NEVER`` - remove ANSI style sequences from all output
+- ``STYLE_TERMINAL`` - remove ANSI style sequences if the output is not going to the terminal
+- ``STYLE_ALWAYS`` - always output ANSI style sequences
-to control the output of ANSI sequences by methods in this module.
+to control the output of ANSI style sequences by methods in this module.
The default is ``STYLE_TERMINAL``.
"""