summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2017-01-27 13:04:33 +0000
committerVinay Sajip <vinay_sajip@yahoo.co.uk>2017-01-27 13:04:33 +0000
commit6ccbbb38caa79f9eb9b93b5767f3787fc80cbac1 (patch)
treeccdce49f37c6aa3800cba1f101e823f561777357
parent49851a445bdbd7783f031fbb3e6972b55b885316 (diff)
downloadcpython-6ccbbb38caa79f9eb9b93b5767f3787fc80cbac1.tar.gz
Fixes #28784: Clarified use of shlex.shlex with punctuation_chars.
-rw-r--r--Doc/library/shlex.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/library/shlex.rst b/Doc/library/shlex.rst
index 4926f04d42..55012f80e8 100644
--- a/Doc/library/shlex.rst
+++ b/Doc/library/shlex.rst
@@ -411,4 +411,6 @@ which characters constitute punctuation. For example::
>>> list(s)
['~/a', '&&', 'b-c', '--color=auto', '||', 'd', '*.py?']
-
+For best effect, ``punctuation_chars`` should be set in conjunction with
+``posix=True``. (Note that ``posix=False`` is the default for
+:class:`~shlex.shlex`.)