classification
Title: Various obvious errors in cookies documentation
Type: Stage: patch review
Components: Documentation Versions: Python 3.2, Python 3.3, Python 2.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: BreamoreBoy, docs@python, petri.lehtinen, r.david.murray, spookylukey
Priority: normal Keywords: easy, patch

Created on 2011-01-24 22:27 by spookylukey, last changed 2014-07-19 02:32 by r.david.murray.

Files
File name Uploaded Description Edit
http_cookies_doc_corrections.diff spookylukey, 2011-01-24 22:27 Patch to docs review
Messages (4)
msg126962 - (view) Author: Luke Plant (spookylukey) Date: 2011-01-24 22:27
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.
msg126979 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2011-01-25 01:35
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 :(
msg223449 - (view) Author: Mark Lawrence (BreamoreBoy) * Date: 2014-07-18 22:57
Given the comments in msg126979 do we formally review this, close as "won't fix" or what?
msg223458 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2014-07-19 02:32
My suggestion was that the help text from the doc strings be used to update the ReST documentation.
History
Date User Action Args
2014-07-19 02:32:35r.david.murraysetmessages: + msg223458
2014-07-18 22:57:17BreamoreBoysetnosy: + BreamoreBoy
messages: + msg223449
2011-11-29 06:12:09ezio.melottisetkeywords: + easy
nosy: + petri.lehtinen
stage: patch review

versions: + Python 3.3, - Python 3.1
2011-01-25 01:35:23r.david.murraysetnosy: + r.david.murray
messages: + msg126979
2011-01-24 22:27:45spookylukeycreate