classification
Title: Document PyUnicode_DecodeFSDefault() and PyUnicode_DecodeFSDefaultAndSize()
Type: Stage:
Components: Documentation, Unicode Versions: Python 3.1, Python 3.2
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, eric.araujo, pitrou, vstinner
Priority: normal Keywords: patch

Created on 2010-05-14 13:34 by vstinner, last changed 2010-05-14 16:09 by vstinner. This issue is now closed.

Files
File name Uploaded Description Edit
unicode_doc.patch vstinner, 2010-05-14 13:34
unicode_doc-2.patch vstinner, 2010-05-14 15:07
Messages (6)
msg105706 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2010-05-14 13:34
Attached patch document PyUnicode_DecodeFSDefault() and PyUnicode_DecodeFSDefaultAndSize() in Doc/c-api/, and fix comment in Include/unicodeobject.c (remove reference to bytearray, and specify that surrogateescape is used).

The patch adds also titles to group unicode functions and methods by topic.
msg105708 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-05-14 13:48
The bulk of the patch seems good to me, with some minor remarks:
- You haven’t used title case consistently in all section titles.
- I’d just say “wchar_t Support” in a title, deleting “for platforms
which support it”.
- You could mark up “bytes” so that users get a link.
- The verb form of “fall back” is in two words, unless I’m lagging on
current technical English.
- You lack an article when saying “the "surrogateescape" error handler”.
- Not sure: Is it better to say “for encoding x, use y” or “to encode x,
use y”?

Sorry for not giving precise line numbers or a diff of a diff, that
wouldn’t be practical.
msg105712 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2010-05-14 14:45
> Is it better to say “for encoding x, use y” or “to encode x,
> use y”?

The latter, IMO. "Encoding" is also a noun.
msg105714 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-05-14 14:55
In this case, it was a verb (a gerund form).
msg105717 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2010-05-14 15:07
Thanks for your remarks: updated patch.
msg105718 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2010-05-14 16:09
Commited: r81168 (py3k), r81169 (3.1).

I also added the paragraph titles to Python2: r81166 (trunk) and r81167 (2.6).
History
Date User Action Args
2010-05-14 16:09:06vstinnersetstatus: open -> closed
resolution: fixed
messages: + msg105718
2010-05-14 15:07:57vstinnersetfiles: + unicode_doc-2.patch

messages: + msg105717
2010-05-14 14:55:51eric.araujosetmessages: + msg105714
title: Document PyUnicode_DecodeFSDefault() and PyUnicode_DecodeFSDefaultAndSize() -> Document PyUnicode_DecodeFSDefault() and PyUnicode_DecodeFSDefaultAndSize()
2010-05-14 14:45:45pitrousetnosy: + pitrou
messages: + msg105712
2010-05-14 13:48:39eric.araujosetnosy: + eric.araujo
title: Document PyUnicode_DecodeFSDefault() and PyUnicode_DecodeFSDefaultAndSize() -> Document PyUnicode_DecodeFSDefault() and PyUnicode_DecodeFSDefaultAndSize()
messages: + msg105708
2010-05-14 13:34:14vstinnercreate