gh-136162: Document encodings
#136164
Open
gh-136162: Document encodings
#136164
+58
−0
Conversation
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
|
@StanFromIreland please, coordinate your work with others :) |
|
@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! |
|
We can reopen it, since yours was the first one :) |
|
Looks good, but you should also document the win32_code_page_search_function() function available on Windows for completeness. |
malemburg
approved these changes
Jul 1, 2025
|
@malemburg thanks for the well commented code, which is the basis for my doc:-) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
search_functionhas possibly the longest singleifstatement in the entirety of CPython...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.encodingsmodule is not documented #136162📚 Documentation preview 📚: https://cpython-previews--136164.org.readthedocs.build/en/136164/library/codecs.html#module-encodings