This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: The new shlex.quote() function should be marked "New in version 3.3"
Type: Stage: resolved
Components: Documentation Versions: Python 3.3
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, eli.bendersky, eric.araujo, python-dev, smarnach
Priority: normal Keywords:

Created on 2012-03-01 13:52 by smarnach, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (4)
msg154693 - (view) Author: Sven Marnach (smarnach) Date: 2012-03-01 13:52
The function shlex.quotes() [1] does not yet exist in Python 3.2 [2], so it should be marked "New in version 3.3." in the docs.

I double-checked that it really does not yet exist in 3.2 and is not only missing from the 3.2 documentation.

[1]: http://docs.python.org/dev/library/shlex.html#shlex.quote
[2]: http://docs.python.org/py3k/library/shlex.html
msg154704 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2012-03-01 17:08
New changeset 73be78d21003 by Eli Bendersky in branch 'default':
Add missing 'versionadded' for shlex.quote; closes #14165
http://hg.python.org/cpython/rev/73be78d21003
msg154723 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2012-03-02 03:38
Thanks, I forgot that :)  shlex.quote used to be pipes.quote, an undocumented but used function; do you think this should be mentioned in shlex.quote’s doc to let people know thaw if they used pipes.quote they have an official upgrade path, or should we just leave it at that?
msg154731 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2012-03-02 05:21
IMHO just leave it. The documentation is mainly for reference, i.e. describing in the best way possible what's available *now*. If you want to mention an upgrade path, write a blog :)
History
Date User Action Args
2022-04-11 14:57:27adminsetgithub: 58373
2012-03-02 05:21:44eli.benderskysetmessages: + msg154731
2012-03-02 03:38:24eric.araujosetnosy: + eric.araujo
messages: + msg154723
2012-03-01 17:08:08python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg154704

resolution: fixed
stage: resolved
2012-03-01 16:57:35eli.benderskysetnosy: + eli.bendersky
2012-03-01 13:52:35smarnachcreate