summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkotfu <kotfu@kotfu.net>2018-08-11 12:27:11 -0600
committerkotfu <kotfu@kotfu.net>2018-08-11 12:29:21 -0600
commitd2fd437db7305f0e4c1479c84fdce2fd8499a38c (patch)
treed0a42ed4696c166e29a0c4efea13189a1a935066
parent7a24851d1f2f620229ca41a4a008811d8634f5d1 (diff)
downloadcmd2-git-d2fd437db7305f0e4c1479c84fdce2fd8499a38c.tar.gz
Update help for ‘quiet’ setting.
-rw-r--r--docs/unfreefeatures.rst16
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