summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2017-01-27 13:04:33 (GMT)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>2017-01-27 13:04:33 (GMT)
commitdc4ce0e0139cbe8867e7bf235ba6af796129a7d0 (patch)
tree85be12e378a232da1b4d72161a9ea2084247bde3
parentdbb5686e7e20355a452e91132e4174c2a4ea84b6 (diff)
downloadcpython-dc4ce0e0139cbe8867e7bf235ba6af796129a7d0.zip
cpython-dc4ce0e0139cbe8867e7bf235ba6af796129a7d0.tar.gz
cpython-dc4ce0e0139cbe8867e7bf235ba6af796129a7d0.tar.bz2
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 4926f04..55012f8 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`.)