GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — gh-62897: Update PyUnicode parameter names by CraftSpider · Pull Request #12680 · python/cpython

Conversation

CraftSpider commented Apr 4, 2019 •

edited by bedevere-bot

Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link

Copy Markdown

Contributor

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

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

serhiy-storchaka left a comment

Copy link

Copy Markdown

Member

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.

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

Comment thread

Doc/c-api/unicode.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/c-api/unicode.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/c-api/unicode.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

serhiy-storchaka added skip news docs Documentation in the Doc dir labels

Apr 6, 2019

CraftSpider commented Apr 6, 2019

Copy link

Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

csabella requested a review from serhiy-storchaka

May 29, 2019 12:09

mangrisano approved these changes

Jul 12, 2019

View reviewed changes

mangrisano left a comment

Copy link

Copy Markdown

Contributor

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.

LGTM. Thank you.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

bedevere-bot added awaiting core review and removed awaiting review labels

Jul 12, 2019

matrixise suggested changes

Sep 11, 2019

View reviewed changes

matrixise left a comment

Copy link

Copy Markdown

Member

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.

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

Comment thread

Doc/c-api/unicode.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/c-api/unicode.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/c-api/unicode.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/c-api/unicode.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/c-api/unicode.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

bedevere-bot removed the awaiting core review label

Sep 11, 2019

bedevere-bot commented Sep 11, 2019

Copy link

Copy Markdown

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!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-bot added the awaiting changes label

Sep 11, 2019

CraftSpider commented Sep 24, 2019

Copy link

Copy Markdown

Contributor Author

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

csabella commented Jan 26, 2020

Copy link

Copy Markdown

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!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

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

CraftSpider commented Feb 2, 2020

Copy link

Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-bot added awaiting change review and removed awaiting changes labels

Feb 2, 2020

bedevere-bot commented Feb 2, 2020

Copy link

Copy Markdown

Thanks for making the requested changes!

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-bot requested a review from matrixise

February 2, 2020 22:01


          Merge branch 'master' into fix-issue-18697

ca6f98a

CraftSpider commented Sep 18, 2020

Copy link

Copy Markdown

Contributor Author

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

arhadthedev commented Apr 1, 2023

Copy link

Copy Markdown

Member

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

iritkatriel added 3.11

only security fixes

3.12

only security fixes

3.13 only 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 only security fixes labels

Dec 5, 2023

miss-islington-app Bot commented Dec 5, 2023

Copy link

Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

miss-islington-app Bot commented Dec 5, 2023

Copy link

Copy Markdown

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!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

miss-islington-app Bot commented Dec 5, 2023

Copy link

Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

miss-islington-app Bot assigned serhiy-storchaka

Dec 5, 2023

miss-islington-app Bot commented Dec 5, 2023

Copy link

Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-app Bot commented Dec 5, 2023

Copy link

Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

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

serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this pull request

Dec 5, 2023


          [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


          [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 Bot commented Dec 5, 2023

Copy link

Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

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


          [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


          [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


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

serhiy-storchaka removed their assignment

Jul 15, 2026

Reviewers

furkanonder

furkanonder approved these changes

serhiy-storchaka

Awaiting requested review from serhiy-storchaka

matrixise

Awaiting requested review from matrixise

+1 more reviewer

mangrisano

mangrisano approved these changes

Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

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.

Uh oh!

There was an error while loading. Please reload this page.

11 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.

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.

GeezerVison

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

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

CraftSpider commented Apr 4, 2019 •

edited by bedevere-bot

Loading

Uh oh!

There was an error while loading. Please reload this page.