[issue11001] Various obvious errors in cookies documentation
New submission from Luke Plant <L.Plant.98@cantab.net>: Docs for SimpleCookie, BaseCookie.value_encode and BaseCookie.value_decode are obviously incorrect. Attempt at patch attached. The error has existed in every Python version I've seen, I've tagged the ones I believe can receive fixes, sorry if I've made a mistake. Thanks. ---------- assignee: docs@python components: Documentation files: http_cookies_doc_corrections.diff keywords: patch messages: 126962 nosy: docs@python, spookylukey priority: normal severity: normal status: open title: Various obvious errors in cookies documentation versions: Python 2.7, Python 3.1, Python 3.2 Added file: http://bugs.python.org/file20507/http_cookies_doc_corrections.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11001> _______________________________________
R. David Murray <rdmurray@bitdance.com> added the comment: The text in the docstrings appears to be accurate, and it seems to me they clarify it even more than your suggested changes do. Also, I think SimpleCookie's encode/decode roughly implements some RFC or another (though there are some tweaks), and it might be worth mentioning that. Even with these changes, though, I don't think it is possible to really understand what cookie is doing without reading the source, and even then it is non-obvious :( ---------- nosy: +r.david.murray _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11001> _______________________________________
Changes by Ezio Melotti <ezio.melotti@gmail.com>: ---------- keywords: +easy nosy: +petri.lehtinen stage: -> patch review versions: +Python 3.3 -Python 3.1 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11001> _______________________________________
Mark Lawrence added the comment: Given the comments in msg126979 do we formally review this, close as "won't fix" or what? ---------- nosy: +BreamoreBoy _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11001> _______________________________________
R. David Murray added the comment: My suggestion was that the help text from the doc strings be used to update the ReST documentation. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11001> _______________________________________
Change by Mark Lawrence <breamoreboy@gmail.com>: ---------- nosy: -BreamoreBoy _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue11001> _______________________________________
Julia <julia.iluyk@gmail.com> added the comment: Working on it at the moment ---------- nosy: +jiliuk _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue11001> _______________________________________
Change by Roundup Robot <devnull@psf.upfronthosting.co.za>: ---------- pull_requests: +13000 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue11001> _______________________________________
Change by Gregory P. Smith <greg@krypto.org>: ---------- versions: +Python 3.7, Python 3.8 -Python 3.2, Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue11001> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset 91cc01f40eec03ece2d6b04ad9ea786e77707d8d by Miss Islington (bot) (Julia Iliuk) in branch 'master': bpo-11001: updated cookie docs (GH-13086) https://github.com/python/cpython/commit/91cc01f40eec03ece2d6b04ad9ea786e777... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue11001> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +13080 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue11001> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset 1fe722cf14db0f786d6df1ff4392f44d37a9f867 by Miss Islington (bot) in branch '3.7': [3.7] bpo-11001: updated cookie docs (GH-13086) (GH-13161) https://github.com/python/cpython/commit/1fe722cf14db0f786d6df1ff4392f44d37a... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue11001> _______________________________________
Gregory P. Smith <greg@krypto.org> added the comment: Thanks Julia! ---------- nosy: +gregory.p.smith resolution: -> fixed stage: patch review -> commit review status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue11001> _______________________________________
participants (8)
-
Ezio Melotti -
Gregory P. Smith
-
Julia
-
Luke Plant
-
Mark Lawrence
-
miss-islington
-
R. David Murray
-
Roundup Robot