Skip to content

gh-54874: Expand unicodedata module documentation #138301

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 4 commits into from
Sep 1, 2025
Merged

gh-54874: Expand unicodedata module documentation #138301

merged 4 commits into from
Sep 1, 2025

Conversation

StanFromIreland
Copy link
Member

@StanFromIreland StanFromIreland commented Aug 31, 2025 •
edited by bedevere-app bot
Loading

Based on @albakin 's patch, using only Latin-1 characters in the text per the issue discussion, and instead of reproducing tables from the UCD, link directly to them.

📚 Documentation preview 📚: https://cpython-previews--138301.org.readthedocs.build/

@StanFromIreland @abalkin
Commit
e17605d 
Co-authored-by: Alexander Belopolsky <[email protected]>
@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Aug 31, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Aug 31, 2025
@StanFromIreland
Copy link
Member Author

StanFromIreland commented Aug 31, 2025 •
edited
Loading

@malemburg FYI you are not a CODEOWNER for this file, you may miss pull requests.

StanFromIreland
StanFromIreland commented Aug 31, 2025
View reviewed changes
@StanFromIreland StanFromIreland changed the title Commit gh-54874: Expand unicodedata module documentation Aug 31, 2025
@bedevere-app bedevere-app bot mentioned this pull request Aug 31, 2025
Closed
malemburg
malemburg approved these changes Sep 1, 2025
View reviewed changes
Copy link
Member

@malemburg malemburg left a comment

Choose a reason for hiding this comment

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

LGTM

Doc/library/unicodedata.rst

The normal form KD (NFKD) will apply the compatibility decomposition, i.e.
The normal form KD (NFKD) will apply the compatibility decomposition, that is,
replace all compatibility characters with their equivalents. The normal form KC
Copy link
Member

Choose a reason for hiding this comment

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

I don't think we should stop using "e.g." and "i.e." in the docs, but if you think this reads better, I don't mind either.

Copy link
Member Author

@StanFromIreland StanFromIreland Sep 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

According to the new docs style guide (created ~last year by the EB IIRC), the abbreviations should not be used. See the devguide for more information.

Copy link
Member

Choose a reason for hiding this comment

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

Fair enough.

@malemburg
Copy link
Member

@malemburg FYI you are not a CODEOWNER for this file, you may miss pull requests.

I know and I have thought about adding me there, but this would result in way too many review requests, I'm afraid. I only have limited time available for this and sometimes with longer gaps.

@malemburg malemburg merged commit 0d383f8 into python:main Sep 1, 2025
31 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Sep 1, 2025
@malemburg malemburg added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Sep 1, 2025
@miss-islington-app
Copy link

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

@miss-islington-app
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 1, 2025
@StanFromIreland @abalkin @miss-islington
pythongh-54874: Expand unicodedata module documentation (pythonGH-138301
d866066 
)

Closes pythonGH-54874
(cherry picked from commit 0d383f8)

Co-authored-by: Stan Ulbrych <[email protected]>
Co-authored-by: Alexander Belopolsky <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 1, 2025
@StanFromIreland @abalkin @miss-islington
pythongh-54874: Expand unicodedata module documentation (pythonGH-138301
9b17586 
)

Closes pythonGH-54874
(cherry picked from commit 0d383f8)

Co-authored-by: Stan Ulbrych <[email protected]>
Co-authored-by: Alexander Belopolsky <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Sep 1, 2025

GH-138345 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 Sep 1, 2025
@bedevere-app
Copy link

bedevere-app bot commented Sep 1, 2025

GH-138346 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Sep 1, 2025
@malemburg
Copy link
Member

@StanFromIreland Is it safe to back this to 3.13 and 3.14 ?

@StanFromIreland StanFromIreland deleted the unicodedata-docs branch September 1, 2025 16:06
@StanFromIreland
Copy link
Member Author

3.14 yes, it is compiled with UCD 16.0.0, as for 3.13, I'll push changes to the backport since it has UCD 15.1.0

malemburg pushed a commit that referenced this pull request Sep 1, 2025
@miss-islington @StanFromIreland @abalkin
[3.13] gh-54874: Expand unicodedata module documentation (GH-138301) (#…
76aa2ab 
…138345)

* gh-54874: Expand unicodedata module documentation (GH-138301)

Closes GH-54874
(cherry picked from commit 0d383f8)

Co-authored-by: Stan Ulbrych <[email protected]>
Co-authored-by: Alexander Belopolsky <[email protected]>

* Changes links to UCD 15.0.0

---------

Co-authored-by: Stan Ulbrych <[email protected]>
Co-authored-by: Alexander Belopolsky <[email protected]>
@malemburg
Copy link
Member

Thanks, @StanFromIreland . I merged the 3.13 backport, but the 3.14 branch seems blocked at the moment.

@StanFromIreland
Copy link
Member Author

StanFromIreland commented Sep 1, 2025 •
edited
Loading

Thanks! Yes, 3.14 is limited to the RM (Hugo) at the moment IIUC.

lkollar pushed a commit to lkollar/cpython that referenced this pull request Sep 9, 2025
@StanFromIreland @abalkin @lkollar
pythongh-54874: Expand unicodedata module documentation (python#138301)
935076f 
Closes python#54874

Co-authored-by: Alexander Belopolsky <[email protected]>
hugovk pushed a commit that referenced this pull request Sep 16, 2025
@miss-islington @StanFromIreland @abalkin
[3.14] gh-54874: Expand unicodedata module documentation (GH-138301) (#…
62294eb 
…138346)

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

@malemburg malemburg malemburg approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news
Projects
Docs PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@StanFromIreland @malemburg