gh-62897: Update PyUnicode parameter names by CraftSpider · Pull Request #12680 · python/cpython

CraftSpider · 2019-04-04T01:15:22Z

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

Issue: Unify arguments names in Unicode object C API documentation #62897

serhiy-storchaka

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

CraftSpider · 2019-04-06T18:29:51Z

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

mangrisano

LGTM. Thank you.

matrixise

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 · 2019-09-11T13:35:11Z

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 · 2019-09-24T20:51:33Z

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

csabella · 2020-01-26T01:09:26Z

@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!

and code

pass.

Function descriptions should now all match the changed parameters of their functions

CraftSpider · 2020-02-02T22:01:35Z

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 · 2020-02-02T22:01:39Z

Thanks for making the requested changes!

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

CraftSpider · 2020-09-18T20:55:14Z

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

arhadthedev · 2023-04-01T13:32:59Z

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

miss-islington-app · 2023-12-05T09:21:57Z

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 · 2023-12-05T09:21:57Z

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 · 2023-12-05T09:22:06Z

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 · 2023-12-05T09:22:18Z

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 · 2023-12-05T09:24:46Z

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

…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 · 2023-12-05T09:29:12Z

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

…H-112744) Standardize PyUnicode C API parameter names across the documentation. (cherry picked from commit b31232d) Co-authored-by: Rune Tynan <[email protected]>

…H-112745) Standardize PyUnicode C API parameter names across the documentation. (cherry picked from commit b31232d) Co-authored-by: Rune Tynan <[email protected]>

Standardize PyUnicode C API parameter names across the documentation. Co-authored-by: Serhiy Storchaka <[email protected]>

the-knights-who-say-ni added the CLA signed label Apr 4, 2019

bedevere-bot added the awaiting review label Apr 4, 2019

serhiy-storchaka reviewed Apr 6, 2019

View reviewed changes

Comment thread Doc/c-api/unicode.rst Outdated

Comment thread Doc/c-api/unicode.rst Outdated

Comment thread Doc/c-api/unicode.rst Outdated

serhiy-storchaka added skip news docs Documentation in the Doc dir labels Apr 6, 2019

csabella requested a review from serhiy-storchaka May 29, 2019 12:09

mangrisano approved these changes Jul 12, 2019

View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Jul 12, 2019

matrixise requested changes Sep 11, 2019

View reviewed changes

Comment thread Doc/c-api/unicode.rst Outdated

Comment thread Doc/c-api/unicode.rst Outdated

Comment thread Doc/c-api/unicode.rst Outdated

Comment thread Doc/c-api/unicode.rst Outdated

Comment thread Doc/c-api/unicode.rst Outdated

bedevere-bot removed the awaiting core review label Sep 11, 2019

bedevere-bot added the awaiting changes label Sep 11, 2019

CraftSpider added 6 commits February 2, 2020 16:53

Standardize unicode function/method parameter names across both headers

27975d9

and code

Update docs to match code names. One code len -> length missed in first

7536bb7

pass.

bpo-18697: Fix issue with variable names being overriden

044d984

bpo-18697 revert all code changes

2e81c7e

bpo-18697: Implement review changes to docs

182f1c8

Update references to parameter names

f69fad4

Function descriptions should now all match the changed parameters of their functions

CraftSpider force-pushed the fix-issue-18697 branch from 945760d to f69fad4 Compare February 2, 2020 21:54

bedevere-bot added awaiting change review and removed awaiting changes labels Feb 2, 2020

bedevere-bot requested a review from matrixise February 2, 2020 22:01

Merge branch 'master' into fix-issue-18697

ca6f98a

Merge branch 'main' into fix-issue-18697

e5e5d26

iritkatriel added 3.11 only security fixes 3.12 only security fixes 3.13 bugs and security fixes labels May 13, 2023

serhiy-storchaka added 2 commits December 4, 2023 23:05

Merge branch 'main' into fix-issue-18697

5966af3

Fix more names.

94b91b8

serhiy-storchaka removed the awaiting change review label Dec 5, 2023

serhiy-storchaka merged commit b31232d into python:main Dec 5, 2023

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 Bot assigned serhiy-storchaka Dec 5, 2023

bedevere-app Bot removed the needs backport to 3.12 only security fixes label Dec 5, 2023

serhiy-storchaka mentioned this pull request Apr 10, 2022

Unify arguments names in Unicode object C API documentation #62897

Closed

bedevere-app Bot removed the needs backport to 3.11 only security fixes label Dec 5, 2023

aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024

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

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]>

Uh oh!

Conversation

CraftSpider commented Apr 4, 2019 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CraftSpider commented Apr 6, 2019

Uh oh!

mangrisano left a comment

Choose a reason for hiding this comment

Uh oh!

matrixise left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bedevere-bot commented Sep 11, 2019

Uh oh!

CraftSpider commented Sep 24, 2019

Uh oh!

csabella commented Jan 26, 2020

Uh oh!

CraftSpider commented Feb 2, 2020

Uh oh!

bedevere-bot commented Feb 2, 2020

Uh oh!

CraftSpider commented Sep 18, 2020

Uh oh!

arhadthedev commented Apr 1, 2023

Uh oh!

miss-islington-app Bot commented Dec 5, 2023

Uh oh!

miss-islington-app Bot commented Dec 5, 2023

Uh oh!

miss-islington-app Bot commented Dec 5, 2023

Uh oh!

miss-islington-app Bot commented Dec 5, 2023

Uh oh!

bedevere-app Bot commented Dec 5, 2023

Uh oh!

bedevere-app Bot commented Dec 5, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

CraftSpider commented Apr 4, 2019 •

edited by bedevere-bot

Loading