diff options
Diffstat (limited to 'docs/unfreefeatures.rst')
| -rw-r--r-- | docs/unfreefeatures.rst | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/docs/unfreefeatures.rst b/docs/unfreefeatures.rst index 41144c8f..a2eff50a 100644 --- a/docs/unfreefeatures.rst +++ b/docs/unfreefeatures.rst @@ -146,16 +146,18 @@ Text output can be colored by wrapping it in the ``colorize`` method. .. automethod:: cmd2.cmd2.Cmd.colorize -.. _quiet: +.. _quiet: +Supressing non-essential output +=============================== -quiet -===== +The ``quiet`` setting controls whether ``self.pfeedback()`` actually produces +any output. If ``quiet`` is ``False``, then the output will be produced. If +``quiet`` is ``True``, no output will be produced. -Controls whether ``self.pfeedback('message')`` output is suppressed; -useful for non-essential feedback that the user may not always want -to read. ``quiet`` is only relevant if -``app.pfeedback`` is sometimes used. +This makes ``self.pfeedback()`` useful for non-essential output like status +messages. Users can control whether they would like to see these messages by changing +the value of the ``quiet`` setting. select |