From 116c3cfe8782c5bc75439770fd874f98f19a69c9 Mon Sep 17 00:00:00 2001 From: Catherine Devlin Date: Tue, 9 Nov 2010 05:22:41 -0500 Subject: doc update --- cmd2.py | 3 ++- docs/unfreefeatures.rst | 14 +++++++++----- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/cmd2.py b/cmd2.py index 0f2ee35..beb2ce1 100755 --- a/cmd2.py +++ b/cmd2.py @@ -440,7 +440,8 @@ class Cmd(cmd.Cmd): special characters that turn on (and then off) text color and style. If the ``colors`` environment paramter is ``False``, or the application is running on Windows, will return ``val`` unchanged. - Available colors/styles: red/blue/green/cyan/magenta, bold, underline''' + ``color`` should be one of the supported strings (or styles): + red/blue/green/cyan/magenta, bold, underline''' if self.colors and (self.stdout == self.initial_stdout): return self.colorcodes[color][True] + val + self.colorcodes[color][False] return val diff --git a/docs/unfreefeatures.rst b/docs/unfreefeatures.rst index 61df001..064fdce 100644 --- a/docs/unfreefeatures.rst +++ b/docs/unfreefeatures.rst @@ -184,15 +184,17 @@ instead. These methods have these advantages: - More concise - ``.pfeedback()`` destination is controlled by :ref:`quiet` parameter. - -.. _quiet: - + color ===== -.. automethod:: cmd2.Cmd.do_quit +Text output can be colored by wrapping it in the ``colorize`` method. + +.. automethod:: cmd2.Cmd.colorize -Quiet +.. _quiet: + +quiet ===== Controls whether ``self.pfeedback('message')`` output is suppressed; @@ -203,6 +205,8 @@ to read. ``quiet`` is only relevant if ``select`` ========== +Presents numbered options to user, as bash ``select``. + ``app.select`` is called from within a method (not by the user directly; it is ``app.select``, not ``app.do_select``). .. automethod:: cmd2.Cmd.select -- cgit v1.2.1