bpo-32077: Documentation: Some Unicode object functions don't indicate whether they return a new reference#11243
Merged
Conversation
…e whether they return a new reference Also adds missing functions. Makes the documentation more comprehensive in terms of indicating whether or not a function returns a new reference.
serhiy-storchaka
added
needs backport to 3.6
docs
serhiy-storchaka
left a comment
serhiy-storchaka
left a comment
Member
There was a problem hiding this comment.
It is better to for review to not squash commits.
Contributor
Author
|
@serhiy-storchaka Ah, sorry about that; will keep addressed comments as a separate commit in the future. |
serhiy-storchaka
approved these changes
Dec 19, 2018
Contributor
|
Thanks @lioncash for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.6, 3.7. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Dec 19, 2018
|
GH-11245 is a backport of this pull request to the 3.7 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Dec 19, 2018
|
GH-11246 is a backport of this pull request to the 3.6 branch. |
miss-islington
added a commit
that referenced
this pull request
Dec 19, 2018
Makes the documentation more comprehensive in terms of indicating whether or not a function returns a new reference. Also fixes some errors and adds missing functions. (cherry picked from commit b2f642c) Co-authored-by: Mat M <mathew1800@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Recreates #4472 because I mistakenly thought it was merged a while back and removed my fork on Github, which ended up orphaning that pull request (sorry about that!)
Original pull request message:
Also adds missing functions. Makes the documentation more comprehensive in terms of indicating whether or not a function returns a new reference.
I've gone over the entries quite a few times, and I'm fairly confident I've amended most of the existing functions and added the new ones that weren't yet added. If I've happened to miss any, just say the word and I'll add them.
I've also noticed the API documentation for bytes objects is also missing entries, which I've made a local commit for, but wasn't sure if it was a good idea to intermix it in this change. I can PR it separately or include it in this one depending on whichever is preferable.
https://bugs.python.org/issue32077