Skip to content

gh-62897: Update PyUnicode parameter names #12680

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
Dec 5, 2023
Merged

gh-62897: Update PyUnicode parameter names #12680

merged 10 commits into from
Dec 5, 2023

Conversation

CraftSpider
Copy link
Contributor

@CraftSpider CraftSpider commented Apr 4, 2019 •
edited by bedevere-bot
Loading

Per the linked issue, PyUnicode functions/methods had many different parameter names, this PR aims to unify them. There is still at least one unanswered question on the bug-tracker, but it seemed a good idea to get a PR of the existing fixes started to solicit active comments.

https://bugs.python.org/issue18697

serhiy-storchaka
serhiy-storchaka reviewed Apr 6, 2019
View reviewed changes
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.

Do not change C sources. Update only the documentation. Don't forget to update the text following the signature.

@serhiy-storchaka serhiy-storchaka added skip news docs Documentation in the Doc dir labels Apr 6, 2019
@CraftSpider
Copy link
Contributor Author

Alright, I'll revert the code changes. Phrasing and discussion on the issue made me think it also wanted the code names unified with the doc names

@csabella csabella requested a review from serhiy-storchaka May 29, 2019 12:09
mangrisano
mangrisano approved these changes Jul 12, 2019
View reviewed changes
Copy link
Contributor

@mangrisano mangrisano left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you.

matrixise
matrixise requested changes Sep 11, 2019
View reviewed changes
Copy link
Member

@matrixise matrixise left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution, but could you check your PR, because you change some parameters, but the documentation is not updated with these new names.

@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

And if you don't make the requested changes, you will be put in the comfy chair!

@CraftSpider
Copy link
Contributor Author

Not sure why there's an error about seeing :end, as that was in the original docs and was preserved unchanged

@csabella
Copy link
Contributor

@CraftSpider, in order to move issues along once changes have been made, this repo uses bots. Please take a look at this message for more info about that. Please also resolve the merge conflict before adding that comment requesting further review. Thanks!

@CraftSpider
Copy link
Contributor Author

I have made the requested changes; please review again

Thank you for the patience, I got into other projects and basically forgot about this for a while

@bedevere-bot
Copy link

Thanks for making the requested changes!

@matrixise: please review the changes made to this pull request.

@CraftSpider
Copy link
Contributor Author

Fixed a merge error caused by other changes since this was made, @matrixise can you please review this when you have time?

@arhadthedev
Copy link
Member

Could anyone help to sort out the new c:... reference target not found: ... warnings please?

@iritkatriel iritkatriel added 3.11 only security fixes 3.12 only security fixes 3.13 bugs and security fixes labels May 13, 2023
@serhiy-storchaka serhiy-storchaka merged commit b31232d into python:main Dec 5, 2023
@serhiy-storchaka serhiy-storchaka added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes and removed 3.11 only security fixes 3.12 only security fixes 3.13 bugs and security fixes labels Dec 5, 2023
@miss-islington-app
Copy link

Thanks @CraftSpider for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Thanks @CraftSpider for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington-app
Copy link

Sorry, @CraftSpider and @serhiy-storchaka, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker b31232ddf7f219ca8ff9e8d0401c02eb0b6ffec3 3.12

@miss-islington-app
Copy link

Sorry, @CraftSpider and @serhiy-storchaka, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker b31232ddf7f219ca8ff9e8d0401c02eb0b6ffec3 3.11

@bedevere-app
Copy link

bedevere-app bot commented Dec 5, 2023

GH-112744 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Dec 5, 2023
@serhiy-storchaka serhiy-storchaka mentioned this pull request Apr 10, 2022
Closed
serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this pull request Dec 5, 2023
@CraftSpider @serhiy-storchaka
[3.12] pythongh-62897: Update PyUnicode C API parameter names (python…
58b2258 
…GH-12680)

Standardize PyUnicode C API parameter names across the documentation.

(cherry picked from commit b31232d)

Co-authored-by: Rune Tynan <[email protected]>
Co-authored-by: Serhiy Storchaka <[email protected]>
serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this pull request Dec 5, 2023
@CraftSpider @serhiy-storchaka
[3.11] pythongh-62897: Update PyUnicode C API parameter names (python…
381ce3a 
…GH-12680)

Standardize PyUnicode C API parameter names across the documentation.

(cherry picked from commit b31232d)

Co-authored-by: Rune Tynan <[email protected]>
Co-authored-by: Serhiy Storchaka <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Dec 5, 2023

GH-112745 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Dec 5, 2023
serhiy-storchaka added a commit that referenced this pull request Dec 5, 2023
@serhiy-storchaka @CraftSpider
[3.12] gh-62897: Update PyUnicode C API parameter names (GH-12680) (G…
f1a0c77 
…H-112744)

Standardize PyUnicode C API parameter names across the documentation.

(cherry picked from commit b31232d)

Co-authored-by: Rune Tynan <[email protected]>
serhiy-storchaka added a commit that referenced this pull request Dec 5, 2023
@serhiy-storchaka @CraftSpider
[3.11] gh-62897: Update PyUnicode C API parameter names (GH-12680) (G…
8a51f6d 
…H-112745)

Standardize PyUnicode C API parameter names across the documentation.

(cherry picked from commit b31232d)

Co-authored-by: Rune Tynan <[email protected]>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@CraftSpider @serhiy-storchaka @aisk
pythongh-62897: Update PyUnicode C API parameter names (pythonGH-12680)
326ba4b 
Standardize PyUnicode C API parameter names across the documentation.

Co-authored-by: Serhiy Storchaka <[email protected]>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@CraftSpider @serhiy-storchaka @Glyphack
pythongh-62897: Update PyUnicode C API parameter names (pythonGH-12680)
3a80a49 
Standardize PyUnicode C API parameter names across the documentation.

Co-authored-by: Serhiy Storchaka <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@furkanonder furkanonder furkanonder approved these changes

@mangrisano mangrisano mangrisano approved these changes

@serhiy-storchaka serhiy-storchaka Awaiting requested review from serhiy-storchaka

@matrixise matrixise Awaiting requested review from matrixise

Assignees

@serhiy-storchaka serhiy-storchaka

Labels
docs Documentation in the Doc dir skip news topic-C-API topic-unicode
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.