# HG changeset patch # User Catherine Devlin # Date 1289298161 18000 # Node ID 9d5ff2ddfdea5b6d34f6e4ca860c2df930e9d103 # Parent 48ebbdfe9dd413f0ad3f7ebe7faca18cc00d6e86 doc update diff -r 48ebbdfe9dd4 -r 9d5ff2ddfdea cmd2.py --- a/cmd2.py Mon Nov 08 08:49:32 2010 -0500 +++ b/cmd2.py Tue Nov 09 05:22:41 2010 -0500 @@ -440,7 +440,8 @@ 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 -r 48ebbdfe9dd4 -r 9d5ff2ddfdea docs/unfreefeatures.rst --- a/docs/unfreefeatures.rst Mon Nov 08 08:49:32 2010 -0500 +++ b/docs/unfreefeatures.rst Tue Nov 09 05:22:41 2010 -0500 @@ -184,15 +184,17 @@ - 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 @@ ``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