Skip to content

bpo-32077: Documentation: Some Unicode object functions don't indicate whether they return a new reference #11243

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

Merged
merged 2 commits into from
Dec 19, 2018

Conversation

lioncash
Copy link
Contributor

@lioncash lioncash commented Dec 19, 2018

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

…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.
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is better to for review to not squash commits.

@lioncash
Copy link
Contributor Author

lioncash commented Dec 19, 2018

@serhiy-storchaka Ah, sorry about that; will keep addressed comments as a separate commit in the future.

@miss-islington
Copy link
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-11243)

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 <[email protected]>
@bedevere-bot
Copy link

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-11243)

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 <[email protected]>
@bedevere-bot
Copy link

GH-11246 is a backport of this pull request to the 3.6 branch.

@lioncash lioncash deleted the refcounts branch December 19, 2018 19:17
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 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants