FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-136162: Document `encodings` by StanFromIreland · Pull Request #136164 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-136162: Document encodings - #136164

Merged
malemburg merged 7 commits into
python:mainfrom
StanFromIreland:doc-encodings
Jul 8, 2025
ConversationCommits (7)ChecksFiles changed
Merged

gh-136162: Document encodings#136164
malemburg merged 7 commits into
python:mainfrom
StanFromIreland:doc-encodings

Conversation

StanFromIreland commented Jul 1, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

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 Bot added awaiting review docs Documentation in the Doc dir skip news labels Jul 1, 2025
github-project-automation Bot moved this to Todo in Docs PRs Jul 1, 2025
bedevere-app Bot mentioned this pull request Jul 1, 2025
Closed
StanFromIreland requested a review from malemburg July 1, 2025 09:15

sobolevn commented Jul 1, 2025

Copy link
Copy Markdown
Member

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

StanFromIreland commented Jul 1, 2025

Copy link
Copy Markdown
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 reopened this Jul 1, 2025

sobolevn commented Jul 1, 2025

Copy link
Copy Markdown
Member

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

malemburg commented Jul 1, 2025

Copy link
Copy Markdown
Member

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

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

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM, thanks @StanFromIreland

StanFromIreland commented Jul 1, 2025

Copy link
Copy Markdown
Member Author

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

vstinner reviewed Jul 2, 2025
View reviewed changes
Comment thread Doc/library/codecs.rst
StanFromIreland commented Jul 2, 2025
View reviewed changes
Comment thread Doc/library/codecs.rst Outdated
StanFromIreland requested a review from vstinner July 2, 2025 14:53
vstinner reviewed Jul 2, 2025
View reviewed changes
Comment thread Doc/library/codecs.rst Outdated
malemburg reviewed Jul 2, 2025
View reviewed changes
Comment thread Doc/library/codecs.rst Outdated
StanFromIreland mentioned this pull request Jul 7, 2025
Merged

StanFromIreland commented Jul 8, 2025

Copy link
Copy Markdown
Member Author

@malemburg Anything else left to do here?

vstinner approved these changes Jul 8, 2025
View reviewed changes

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM

malemburg merged commit ffd7f2f into python:main Jul 8, 2025
github-project-automation Bot moved this from Todo to Done in Docs PRs Jul 8, 2025

malemburg commented Jul 8, 2025

Copy link
Copy Markdown
Member

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

Thanks @StanFromIreland and @sobolevn .

malemburg added needs backport to 3.13 only security fixes needs backport to 3.14 bugs and security fixes labels Jul 9, 2025

miss-islington-app Bot commented Jul 9, 2025

Copy link
Copy Markdown

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

miss-islington-app Bot commented Jul 9, 2025

Copy link
Copy Markdown

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
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 Bot commented Jul 9, 2025

Copy link
Copy Markdown

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
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 Bot removed the needs backport to 3.13 only security fixes label Jul 9, 2025

bedevere-app Bot commented Jul 9, 2025

Copy link
Copy Markdown

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

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Jul 9, 2025

malemburg commented Jul 9, 2025

Copy link
Copy Markdown
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
[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
[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>
AndPuQing pushed a commit to AndPuQing/cpython that referenced this pull request Jul 11, 2025
pythongh-136162: Document encodings package functions (python#136164)
47d9ed6 
Closes python#136162.
Pranjal095 pushed a commit to Pranjal095/cpython that referenced this pull request Jul 12, 2025
pythongh-136162: Document encodings package functions (python#136164)
4f94db7 
Closes python#136162.
picnixz pushed a commit to picnixz/cpython that referenced this pull request Jul 13, 2025
pythongh-136162: Document encodings package functions (python#136164)
190510d 
Closes python#136162.
taegyunkim pushed a commit to taegyunkim/cpython that referenced this pull request Aug 4, 2025
pythongh-136162: Document encodings package functions (python#136164)
d0b532e 
Closes python#136162.
Agent-Hellboy pushed a commit to Agent-Hellboy/cpython that referenced this pull request Aug 19, 2025
pythongh-136162: Document encodings package functions (python#136164)
7771cfb 
Closes python#136162.
kumaraditya303 pushed a commit to miss-islington/cpython that referenced this pull request Sep 9, 2025
[3.14] pythongh-136162: Document encodings package functions (pytho…
0825274 
…nGH-136164) (python#136454)

pythongh-136162: Document `encodings` package functions (pythonGH-136164)

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

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
StanFromIreland deleted the doc-encodings branch March 26, 2026 17:24
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

malemburg malemburg approved these changes
vstinner vstinner approved these changes
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

Back | FazBrowse Home | New Git URL