mirror of
https://github.com/python/cpython.git
synced 2025-12-31 04:23:37 +00:00
8a598fb623
We had the definition of what makes a character "printable" documented in three places, giving two different definitions.
The definition in the comment on `_PyUnicode_IsPrintable` was inverted; correct that.
With that correction, the two definitions turn out to be equivalent -- but to confirm that, you have to go look up, or happen to know, that those are the only five "Other" categories and only three "Separator" categories in the Unicode character database. That makes it hard for the reader to tell whether they really are the same, or if there's some subtle difference in the intended semantics.
Fix that by cutting the C API docs' and the C comment's copies of the subtle details, in favor of referring to the Python-level docs. That ensures it's explicit that these are all meant to agree, and also lets us concentrate improvements to the wording in one place.
Speaking of which, borrow some ideas from the C comment, along with other tweaks, to hopefully add a bit more clarity to that one newly-centralized copy in the docs.
Also add a thorough test that the implementation agrees with this definition.
Co-authored-by: Greg Price <gnprice@gmail.com>
(cherry picked from commit
|
||
|---|---|---|
| .. | ||
| bytearrayobject.c.h | ||
| bytesobject.c.h | ||
| classobject.c.h | ||
| codeobject.c.h | ||
| complexobject.c.h | ||
| descrobject.c.h | ||
| dictobject.c.h | ||
| enumobject.c.h | ||
| floatobject.c.h | ||
| funcobject.c.h | ||
| listobject.c.h | ||
| longobject.c.h | ||
| memoryobject.c.h | ||
| moduleobject.c.h | ||
| odictobject.c.h | ||
| structseq.c.h | ||
| tupleobject.c.h | ||
| typeobject.c.h | ||
| typevarobject.c.h | ||
| unicodeobject.c.h | ||