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

gh-136162: Document encodings#136164

malemburg merged 7 commits into from
Jul 8, 2025

Conversation

@StanFromIreland
Copy link
Member

@StanFromIrelandStanFromIreland 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-appbedevere-appbot added awaiting review docs Documentation in the Doc dir skip news labels Jul 1, 2025
@bedevere-appbedevere-appbot mentioned this pull request Jul 1, 2025
Closed
@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
MemberAuthor

StanFromIreland commented Jul 1, 2025

@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!

@sobolevnsobolevn 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

malemburg commented Jul 1, 2025

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

malemburg
malemburg approved these changes Jul 1, 2025
View reviewed changes
Copy link
Member

@malemburgmalemburg 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
MemberAuthor

StanFromIreland commented Jul 1, 2025

@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
vstinner
vstinner reviewed Jul 2, 2025
View reviewed changes
malemburg
malemburg reviewed Jul 2, 2025
View reviewed changes
@StanFromIrelandStanFromIreland mentioned this pull request Jul 7, 2025
Merged
@StanFromIreland
Copy link
MemberAuthor

StanFromIreland commented Jul 8, 2025

@malemburg Anything else left to do here?

vstinner
vstinner approved these changes Jul 8, 2025
View reviewed changes
Copy link
Member

@vstinnervstinner left a comment

Choose a reason for hiding this comment

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

LGTM

@malemburgmalemburg merged commit ffd7f2f into python:mainJul 8, 2025
25 checks passed
@github-project-automationgithub-project-automationbot moved this from Todo to Done in Docs PRsJul 8, 2025
@malemburg
Copy link
Member

malemburg commented Jul 8, 2025

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

Thanks @StanFromIreland and @sobolevn .

@malemburgmalemburg 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

miss-islington-appbot commented Jul 9, 2025

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

miss-islington-appbot commented Jul 9, 2025

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: Documentencodingspackage functions (pythonGH-136164
333528b
) ClosespythonGH-136162. (cherry picked from commit ffd7f2f) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-appbot 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: Documentencodingspackage functions (pythonGH-136164
fe171cd
) ClosespythonGH-136162. (cherry picked from commit ffd7f2f) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@bedevere-appbedevere-appbot removed the needs backport to 3.13 bugs and security fixes label Jul 9, 2025
@bedevere-app
Copy link

bedevere-appbot commented Jul 9, 2025

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

@bedevere-appbedevere-appbot removed the needs backport to 3.14 bugs and security fixes label Jul 9, 2025
@malemburg
Copy link
Member

malemburg commented Jul 9, 2025

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: Documentencodingspackage functions (GH-136164) (#…
21bcecf
…136453) gh-136162: Document `encodings` package functions (GH-136164) ClosesGH-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: Documentencodingspackage functions (GH-136164) (#…
a9d2f08
…136454) gh-136162: Document `encodings` package functions (GH-136164) ClosesGH-136162. (cherry picked from commit ffd7f2f) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
AndPuQing pushed a commit to AndPuQing/cpython that referenced this pull request Jul 11, 2025
@StanFromIreland@AndPuQing
pythongh-136162: Documentencodingspackage functions (python#136164)
47d9ed6
Closespython#136162.
Pranjal095 pushed a commit to Pranjal095/cpython that referenced this pull request Jul 12, 2025
@StanFromIreland@Pranjal095
pythongh-136162: Documentencodingspackage functions (python#136164)
4f94db7
Closespython#136162.
picnixz pushed a commit to picnixz/cpython that referenced this pull request Jul 13, 2025
@StanFromIreland@picnixz
pythongh-136162: Documentencodingspackage functions (python#136164)
190510d
Closespython#136162.
taegyunkim pushed a commit to taegyunkim/cpython that referenced this pull request Aug 4, 2025
@StanFromIreland@taegyunkim
pythongh-136162: Documentencodingspackage functions (python#136164)
d0b532e
Closespython#136162.
Agent-Hellboy pushed a commit to Agent-Hellboy/cpython that referenced this pull request Aug 19, 2025
@StanFromIreland@Agent-Hellboy
pythongh-136162: Documentencodingspackage functions (python#136164)
7771cfb
Closespython#136162.
kumaraditya303 pushed a commit to miss-islington/cpython that referenced this pull request Sep 9, 2025
@miss-islington@StanFromIreland@kumaraditya303
[3.14]pythongh-136162: Documentencodingspackage functions (pytho…
0825274
…nGH-136164) (python#136454) pythongh-136162: Document `encodings` package functions (pythonGH-136164) ClosespythonGH-136162. (cherry picked from commit ffd7f2f) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@malemburgmalemburgmalemburg approved these changes

@vstinnervstinnervstinner approved these changes

@sobolevnsobolevnAwaiting requested review from sobolevn

Assignees

No one assigned

Labels

docsDocumentation in the Doc dirskip 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