-
-
Notifications
You must be signed in to change notification settings - Fork 31.8k
GH-109975: Copyedit 3.13 What's New: C API #124313
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work!
Some lines look too long, and some lines look unnecessary short. Could you please reformat the text using the recommended maximal line length (I think 79 from PEP 12 is applied here)?
Alphabetical order is perhaps necessary for such large number of changes, but in some cases I think that it would be better to group semantically close changes together. For example, PyObject_GenericHash and Py_HashPointer. Or PyMapping_GetOptionalItem, which is close to PyDict_*
changes and to PyObject_GetOptionalAttr, and to PyMapping_HasKeyWithError. But I do not see a way how this can be improved.
* PyDict*: PyMapping_GetOptionalItem and PyObject_GetOptionalAttr * Py_HashPointer and Py_HashPointer
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the review, I've pushed two commits.
Some lines look too long, and some lines look unnecessary short. Could you please reformat the text using the recommended maximal line length (I think 79 from PEP 12 is applied here)?
The devguide also says 79/80, but in a few places I've gone a couple of characters over to avoid a mostly empty orphan line.
I've rebalanced the particularly egregious case you pointed out, but breaking lines early is a somewhat intentional choice (some people call it semantic line breaks) where I break the line at punctuation or a clause in a sentence. This tends to lead to smaller diffs later down the line, as re-wrapping an entire paragraph for changing a single word can be avoided.
(This is of course only visible in the .rst
-- the vast majority readers will never know which lines were broken where in the HTML or PDF output)
A
Thanks @AA-Turner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13. |
Sorry, @AA-Turner, I could not cleanly backport this to
|
) (cherry picked from commit 9d0a752) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
GH-124334 is a backport of this pull request to the 3.13 branch. |
A copy-editing pass for C API. This one is quite large as we move the changes to, deprecated, and removed C API sub-sections from the 'porting' section to the 'C API' section, where they belong.
c-api-pending-removal-in-XXX.rst
as this PR was getting too large already, I'll do that after this PR and assess if anything pressing needs updating.A
📚 Documentation preview 📚: https://cpython-previews--124313.org.readthedocs.build/en/124313/whatsnew/3.13.html#c-api-changes