Skip to content

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

Merged
vstinner merged 8 commits into
python:mainfrom
cdce8p:docs-unicode
Feb 20, 2025
Merged

gh-46236: Document PyUnicode_RSplit, PyUnicode_Partition and PyUnicode_RPartition#130191
vstinner merged 8 commits into
python:mainfrom
cdce8p:docs-unicode

Conversation

@cdce8p

@cdce8pcdce8p commented Feb 16, 2025•
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Contributor

@bedevere-appbedevere-appBot added docs Documentation in the Doc dir awaiting review labels Feb 16, 2025
@bedevere-appbedevere-appBot mentioned this pull request Feb 16, 2025
Closed
33 tasks
cdce8p
cdce8p commented Feb 16, 2025
View reviewed changes
Comment threadDoc/data/refcounts.dat
picnixz
picnixz reviewed Feb 16, 2025
View reviewed changes
Comment threadDoc/c-api/unicode.rst Outdated
Comment threadDoc/c-api/unicode.rst Outdated
Comment threadDoc/data/refcounts.dat
@picnixz
picnixz self-requested a review February 16, 2025 15:39
picnixz
picnixz reviewed Feb 16, 2025
View reviewed changes
Comment threadDoc/c-api/unicode.rst Outdated
Comment threadDoc/c-api/unicode.rst Outdated
picnixz
picnixz reviewed Feb 17, 2025
View reviewed changes

@picnixzpicnixz left a comment

Copy link
Copy Markdown
Member

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

Comment threadDoc/c-api/unicode.rst Outdated
picnixz
picnixz approved these changes Feb 17, 2025
View reviewed changes

@picnixzpicnixz left a comment •
edited
Loading

Copy link
Copy Markdown
Member

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

vstinner
vstinner reviewed Feb 17, 2025
View reviewed changes
Comment threadDoc/c-api/unicode.rst
Comment threadMisc/NEWS.d/next/Documentation/2025-02-16-14-57-00.gh-issue-46236.2HuS4S.rst Outdated
vstinner
vstinner reviewed Feb 17, 2025
View reviewed changes
Comment threadDoc/c-api/unicode.rst
vstinner
vstinner approved these changes Feb 17, 2025
View reviewed changes

@vstinnervstinner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@encukou

encukou commented Feb 20, 2025

Copy link
Copy Markdown
Member

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*).

encukou
encukou reviewed Feb 20, 2025
View reviewed changes

@encukouencukou left a comment

Copy link
Copy Markdown
Member

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:

Comment threadDoc/c-api/unicode.rst
Comment threadDoc/c-api/unicode.rst
Comment threadDoc/c-api/unicode.rst
@cdce8p@encukou
Apply suggestions from review
0957364
Co-authored-by: Petr Viktorin <encukou@gmail.com>
@vstinner
vstinner merged commit 0f5b821 into python:mainFeb 20, 2025
@vstinnervstinner added the needs backport to 3.13 bugs and security fixes label Feb 20, 2025
@miss-islington-app

miss-islington-appBot commented Feb 20, 2025

Copy link
Copy Markdown

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
@cdce8p@encukou@miss-islington
pythongh-46236: Document PyUnicode_RSplit, PyUnicode_Partition and Py…
434576e
…Unicode_RPartition (pythonGH-130191)
(cherry picked from commit 0f5b821)
Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
@bedevere-app

bedevere-appBot commented Feb 20, 2025

Copy link
Copy Markdown

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

@bedevere-appbedevere-appBot 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
@vstinnervstinner added the needs backport to 3.12 only security fixes label Feb 20, 2025
@miss-islington-app

miss-islington-appBot commented Feb 20, 2025

Copy link
Copy Markdown

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
@cdce8p@encukou@miss-islington
pythongh-46236: Document PyUnicode_RSplit, PyUnicode_Partition and Py…
e2f703e
…Unicode_RPartition (pythonGH-130191)
(cherry picked from commit 0f5b821)
Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
@bedevere-app

bedevere-appBot commented Feb 20, 2025

Copy link
Copy Markdown

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

@bedevere-appbedevere-appBot removed the needs backport to 3.12 only security fixes label Feb 20, 2025
@vstinner

vstinner commented Feb 20, 2025

Copy link
Copy Markdown
Member

Merged, thank you @cdce8p.

vstinner pushed a commit that referenced this pull request Feb 20, 2025
@miss-islington@cdce8p@encukou
[3.13]gh-46236: Document PyUnicode_RSplit, PyUnicode_Partition and P…
2ac2555
…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 <30130371+cdce8p@users.noreply.github.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
vstinner pushed a commit that referenced this pull request Feb 20, 2025
@miss-islington@cdce8p@encukou
[3.12]gh-46236: Document PyUnicode_RSplit, PyUnicode_Partition and P…
5c0aba0
…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 <30130371+cdce8p@users.noreply.github.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
@cdce8pcdce8p mentioned this pull request Jun 12, 2025
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vstinnervstinnervstinner approved these changes
@encukouencukouencukou approved these changes
@picnixzpicnixzpicnixz approved these changes

Assignees

No one assigned

Labels

docsDocumentation in the Doc dir

Projects

Docs PRs
Status: Todo

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@cdce8p@encukou@vstinner@picnixz