diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2020-02-25 10:56:19 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-25 10:56:19 -0500 |
| commit | 21dab8b1664dcd88a1872f394890460977e01632 (patch) | |
| tree | af144311b0b3e143a88c3b36734fead39338432b /cmd2/ansi.py | |
| parent | f636aa1375fdeafe123b5e6483d5c96da7d3f2ba (diff) | |
| parent | f18390b31e52eb2bfebab34841da19cac25fab4c (diff) | |
| download | cmd2-git-21dab8b1664dcd88a1872f394890460977e01632.tar.gz | |
Merge pull request #901 from python-cmd2/api_docs_cleanup
Address comments from PR #899
Diffstat (limited to 'cmd2/ansi.py')
| -rw-r--r-- | cmd2/ansi.py | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/cmd2/ansi.py b/cmd2/ansi.py index 27c9e87a..ceb135ec 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 +# Controls when ANSI 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``. """ |