summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl-Aksel Puulmann2013-04-06 09:13:47 +0200
committerKarl-Aksel Puulmann2013-04-06 09:13:47 +0200
commit483f8861e2fb546f85191aa618152929328b175a (patch)
treecfa8499092f49ce83b1a97064f453a3095851125
parentee8a3f9b3212b72de4b96b608c31db4ef087f638 (diff)
downloadmailman-483f8861e2fb546f85191aa618152929328b175a.tar.gz
mailman-483f8861e2fb546f85191aa618152929328b175a.tar.zst
mailman-483f8861e2fb546f85191aa618152929328b175a.zip
Added an example to the docs
-rw-r--r--src/mailman/commands/docs/conf.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/mailman/commands/docs/conf.rst b/src/mailman/commands/docs/conf.rst
index 069bce553..e3a8a488f 100644
--- a/src/mailman/commands/docs/conf.rst
+++ b/src/mailman/commands/docs/conf.rst
@@ -14,7 +14,7 @@ a specific key-value pair, or several key-value pairs.
... key = None
... section = None
... output = None
- ... sort = None
+ ... sort = False
>>> from mailman.commands.cli_conf import Conf
>>> command = Conf()
@@ -65,5 +65,12 @@ If you specify both a section and a key, you will get the corresponding value.
>>> command.process(FakeArgs)
noreply@example.com
+You can also sort the output. The output will be first sorted by section, then by key.
+
+ >>> FakeArgs.section = 'shell'
+ >>> FakeArgs.sort = True
+ [shell] banner: Welcome to the GNU Mailman shell
+ [shell] prompt: >>>
+ [shell] use_ipython: no
.. _`Postfix command postconf(1)`: http://www.postfix.org/postconf.1.html