Skip to content

gh-136162: Document encodings #136164

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 7 commits into from
Jul 8, 2025
Merged

gh-136162: Document encodings #136164

merged 7 commits into from
Jul 8, 2025
+61 −1

Conversation

StanFromIreland
Copy link
Member

@StanFromIreland StanFromIreland commented Jul 1, 2025 •
edited
Loading

search_function has possibly the longest single if statement in the entirety of CPython...

we should add a note that these functions should normally not be used directly

I added a .. note::, but switching to a .. warning:: seems like a good idea.

I am split on documenting win32_code_page_search_function, but I have a patch ready. To me it seems as more of a helper function, which could be made private.

📚 Documentation preview 📚: https://cpython-previews--136164.org.readthedocs.build/en/136164/library/codecs.html#module-encodings

@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Jul 1, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Jul 1, 2025
@bedevere-app bedevere-app bot mentioned this pull request Jul 1, 2025
Closed
@StanFromIreland StanFromIreland requested a review from malemburg July 1, 2025 09:15
@sobolevn
Copy link
Member

sobolevn commented Jul 1, 2025

@StanFromIreland please, coordinate your work with others :)
I also had a PR for this, but I wanted to discuss it first.

@StanFromIreland
Copy link
Member Author

@sobolevn Oops... I must have missed it in your post. I believed that no one else had started work on it so I went ahead. I didn't see value in saying I was working on it if I am to open PR ten minutes later. Apologies!

@sobolevn sobolevn reopened this Jul 1, 2025
@sobolevn
Copy link
Member

sobolevn commented Jul 1, 2025

We can reopen it, since yours was the first one :)
Just something to keep in mind.

@malemburg
Copy link
Member

Looks good, but you should also document the win32_code_page_search_function() function available on Windows for completeness.

@StanFromIreland StanFromIreland requested a review from sobolevn July 1, 2025 11:26
malemburg
malemburg approved these changes Jul 1, 2025
View reviewed changes
Copy link
Member

@malemburg malemburg left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM, thanks @StanFromIreland

@StanFromIreland
Copy link
Member Author

@malemburg thanks for the well commented code, which is the basis for my doc:-)

vstinner
vstinner reviewed Jul 2, 2025
View reviewed changes
StanFromIreland
StanFromIreland commented Jul 2, 2025
View reviewed changes
@StanFromIreland StanFromIreland requested a review from vstinner July 2, 2025 14:53
vstinner
vstinner reviewed Jul 2, 2025
View reviewed changes
malemburg
malemburg reviewed Jul 2, 2025
View reviewed changes
@StanFromIreland StanFromIreland mentioned this pull request Jul 7, 2025
Merged
@StanFromIreland
Copy link
Member Author

@malemburg Anything else left to do here?

vstinner
vstinner approved these changes Jul 8, 2025
View reviewed changes
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

@malemburg malemburg merged commit ffd7f2f into python:main Jul 8, 2025
25 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Jul 8, 2025
@malemburg
Copy link
Member

I'm not sure whether we should backport this change. @vstinner ?

Thanks @StanFromIreland and @sobolevn .

@malemburg malemburg added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Jul 9, 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 Jul 9, 2025
@StanFromIreland @miss-islington
pythongh-136162: Document encodings package functions (pythonGH-136164
333528b 
)

Closes pythonGH-136162.
(cherry picked from commit ffd7f2f)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Jul 9, 2025

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 9, 2025
@StanFromIreland @miss-islington
pythongh-136162: Document encodings package functions (pythonGH-136164
fe171cd 
)

Closes pythonGH-136162.
(cherry picked from commit ffd7f2f)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jul 9, 2025
@bedevere-app
Copy link

bedevere-app bot commented Jul 9, 2025

GH-136454 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 Jul 9, 2025
@malemburg
Copy link
Member

I'll add backports as well. This is documenting existing code, after all.

malemburg pushed a commit that referenced this pull request Jul 9, 2025
@miss-islington @StanFromIreland
[3.13] gh-136162: Document encodings package functions (GH-136164) (#…
21bcecf 
…136453)

gh-136162: Document `encodings` package functions (GH-136164)

Closes GH-136162.
(cherry picked from commit ffd7f2f)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
malemburg pushed a commit that referenced this pull request Jul 9, 2025
@miss-islington @StanFromIreland
[3.14] gh-136162: Document encodings package functions (GH-136164) (#…
a9d2f08 
…136454)

gh-136162: Document `encodings` package functions (GH-136164)

Closes GH-136162.
(cherry picked from commit ffd7f2f)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
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

@vstinner vstinner vstinner approved these changes

@sobolevn sobolevn Awaiting requested review from sobolevn

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.
4 participants
@StanFromIreland @sobolevn @malemburg @vstinner