Fixes #28784: Clarified use of shlex.shlex with punctuation_chars.

dc4ce0e0 · Vinay Sajip · dbb5686e · dc4ce0e0
Commit dc4ce0e0 authored Jan 27, 2017 by Vinay Sajip
Hide whitespace changes
Inline Side-by-side

Showing with 3 additions and 1 deletion

Doc/library/shlex.rst Doc/library/shlex.rst +3 -1

No files found.
--- 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`.)