[issue31873] Inconsistent capitalization of proper noun - Unicode.

New submission from David Antonini <davidantonini@hotmail.com>: Make 'unicode'/'Unicode' capitalization consistent. 'Unicode' is a proper noun, and as such should be capitalized. I submitted a pull request correcting the inconsistent capitalization in the Unicode page of the Documentation - Doc/c-api/unicode.rst - capitalizing 12 errant instances to reflect the correct capitalization in most of the document. I was then requested to open an issue here for discussion. ---------- assignee: docs@python components: Documentation messages: 305050 nosy: docs@python, toonarmycaptain priority: normal pull_requests: 4096 severity: normal status: open title: Inconsistent capitalization of proper noun - Unicode. type: enhancement _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31873> _______________________________________

Serhiy Storchaka <storchaka+cpython@gmail.com> added the comment: I agree that the inconsistency should be fixed. But I'm not sure that we should use the words "an Unicode object" in Python 3. In many similar cases ("a bytes object", "a type object", "a module object") the name of Python type is used. "unicode" was a name of Python type in Python 2. In Python 3 it is "str". The term "Unicode string" also is widely used. Should not we use "a str object", "a string object", "a Unicode string" or "a Unicode string object" in the C API documentation? ---------- components: +Unicode nosy: +benjamin.peterson, ezio.melotti, haypo, lemburg, martin.panter, r.david.murray, serhiy.storchaka stage: -> patch review versions: +Python 3.6, Python 3.7 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31873> _______________________________________

R. David Murray <rdmurray@bitdance.com> added the comment: It may be a proper noun, but it is conventionally spelled with a lowercase letter when referring to the type/object. It would be spelled with an upper case letter when referring to the *standard*. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31873> _______________________________________

David Antonini <davidantonini@hotmail.com> added the comment: Does the Unicode documentation currently conform to that convention, or does it require editing? It appears to me that a lot of cases where reference to "Unicode object" is currently capitalised (most of them, in fact) may need to be modified. However, it would seem that there is a grey area in making a distinction between reference to the unicode type as implemented in Python and reference to the standard as a descriptor of the format of an object? The way I read there a lot of the cases are in essence a reference to both. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31873> _______________________________________

R. David Murray <rdmurray@bitdance.com> added the comment: In this case I think the cost of editing for consistency may be higher than the value, especially since as you say there are ambiguous cases. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31873> _______________________________________

Julien Palard <julien+python@palard.fr> added the comment: Currently in our documentation there's 89 "Unicode obj" vs 8 "unicode obj" so I'll go for it. ---------- nosy: +mdk _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31873> _______________________________________

Marc-Andre Lemburg <mal@egenix.com> added the comment: If you want to do this correctly, you have to check each case: * if "unicode object" refers to a C PyUnicode object, it's probably better to use "PyUnicode object" * if "unicode object" refers to a C PyObject object, with type "unicode", it's probably better to leave it as is * if "unicode object" refers to a Python unicode object, it's probably better to call it "Unicode string object" or just "string object" in Python 3 * if "unicode object" does not indicate whether Python or C is meant, "Unicode object" is probably better ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31873> _______________________________________

Julien Palard <julien+python@palard.fr> added the comment: New changeset 85225b6a58a516c50c055d5114668ed2fcdcda8c by Julien Palard (toonarmycaptain) in branch 'master': bpo-31873: Update unicode.rst - 'unicode' capitalization (GH-4125) https://github.com/python/cpython/commit/85225b6a58a516c50c055d5114668ed2fcd... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31873> _______________________________________

Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- keywords: +patch pull_requests: +13105 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31873> _______________________________________

Julien Palard <julien+python@palard.fr> added the comment: I merged it, it's a small change that is consistent enough for me with the rest of the file and the doc. Marc-Andre is right though, and if anyone have the courage, the whole doc should be proofread to update accordingly, but let's make it a whole other PR. Thanks David for your contribution and sorry for the delay. ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31873> _______________________________________

miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset ed8860c5af87d78d312ae30dd2d6bedc60bd86e5 by Miss Islington (bot) in branch '3.7': bpo-31873: Update unicode.rst - 'unicode' capitalization (GH-4125) https://github.com/python/cpython/commit/ed8860c5af87d78d312ae30dd2d6bedc60b... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue31873> _______________________________________
participants (6)
-
David Antonini
-
Julien Palard
-
Marc-Andre Lemburg
-
miss-islington
-
R. David Murray
-
Serhiy Storchaka