Skip to content
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

gh-46236: Document PyUnicode_RSplit, PyUnicode_Partition and PyUnicode_RPartition #130191

Merged
merged 8 commits into from
Feb 20, 2025

Conversation

cdce8p
Copy link
Contributor

@cdce8p cdce8p commented Feb 16, 2025

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir awaiting review labels Feb 16, 2025
@bedevere-app bedevere-app bot mentioned this pull request Feb 16, 2025
33 tasks
@picnixz picnixz self-requested a review February 16, 2025 15:39
Copy link
Member

@picnixz picnixz left a comment

Choose a reason for hiding this comment

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

I've never sent my review...

Copy link
Member

@picnixz picnixz left a comment

Choose a reason for hiding this comment

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

Let's do a follow-up for normalizing all the naming and check if we need to be pedantic with string vs Unicode string (it may matter as it could hint about the most general kind of the Unicode object).

EDIT: Fine to leave the lonely cases as they are unless someone has time to fix those kind of typos. Though it's possibly better to simply add a top-level paragraph saying "Unless stated otherwise, the terminology "string" refers to a Unicode string" (and not just ASCII-only string).

Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

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

LGTM

@encukou
Copy link
Member

encukou commented Feb 20, 2025

EDIT: Fine to leave the lonely cases as they are unless someone has time to fix those kind of typos. Though it's possibly better to simply add a top-level paragraph saying "Unless stated otherwise, the terminology "string" refers to a Unicode string" (and not just ASCII-only string).

AFAIK that's a holdover from Python 2, where str was PyBytes.
Nowadays we can say Python string or string object (or simply string if it's clear that it's not a char*).

Copy link
Member

@encukou encukou left a comment

Choose a reason for hiding this comment

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

There are two more items I'd like to see in new docs:

Co-authored-by: Petr Viktorin <[email protected]>
@vstinner vstinner merged commit 0f5b821 into python:main Feb 20, 2025
24 checks passed
@vstinner vstinner added the needs backport to 3.13 bugs and security fixes label Feb 20, 2025
@miss-islington-app
Copy link

Thanks @cdce8p for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 20, 2025
…Unicode_RPartition (pythonGH-130191)

(cherry picked from commit 0f5b821)

Co-authored-by: Marc Mueller <[email protected]>
Co-authored-by: Petr Viktorin <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Feb 20, 2025

GH-130360 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Feb 20, 2025
@cdce8p cdce8p deleted the docs-unicode branch February 20, 2025 15:43
@vstinner vstinner added the needs backport to 3.12 bug and security fixes label Feb 20, 2025
@miss-islington-app
Copy link

Thanks @cdce8p for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 20, 2025
…Unicode_RPartition (pythonGH-130191)

(cherry picked from commit 0f5b821)

Co-authored-by: Marc Mueller <[email protected]>
Co-authored-by: Petr Viktorin <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Feb 20, 2025

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Feb 20, 2025
@vstinner
Copy link
Member

Merged, thank you @cdce8p.

vstinner pushed a commit that referenced this pull request Feb 20, 2025
…yUnicode_RPartition (GH-130191) (#130360)

gh-46236: Document PyUnicode_RSplit, PyUnicode_Partition and PyUnicode_RPartition (GH-130191)
(cherry picked from commit 0f5b821)

Co-authored-by: Marc Mueller <[email protected]>
Co-authored-by: Petr Viktorin <[email protected]>
vstinner pushed a commit that referenced this pull request Feb 20, 2025
…yUnicode_RPartition (GH-130191) (#130361)

gh-46236: Document PyUnicode_RSplit, PyUnicode_Partition and PyUnicode_RPartition (GH-130191)
(cherry picked from commit 0f5b821)

Co-authored-by: Marc Mueller <[email protected]>
Co-authored-by: Petr Viktorin <[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
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

4 participants