gh-90241: Clarify documentation for PyUnicode_FSConverter and PyUnicode_FSDecoder #128451
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
…yUnicode_FSDecoder
serhiy-storchaka
added
docs
|
LGTM, but see my comment on the issue. |
| conversion function: | ||
|
|
||
| .. c:function:: int PyUnicode_FSConverter(PyObject* obj, void* result) | ||
|
|
||
| ParseTuple converter: encode :class:`str` objects -- obtained directly or | ||
| :ref:`PyArg_Parse\* converter <arg-parsing>`: encode :class:`str` objects -- obtained directly or |
There was a problem hiding this comment.
Suggested change
| :ref:`PyArg_Parse\* converter <arg-parsing>`: encode :class:`str` objects -- obtained directly or | |
| :ref:`PyArg_Parse\* converter <arg-parsing>`: encodes :class:`str` objects -- obtained directly or |
Small typo
|
They are not typos. |
Co-authored-by: Stan Ulbrych <[email protected]>
- PyArg_Parse converter encode str objects
+ PyArg_Parse converter encodes str objectsSince |
|
This is not related. Imperative style is more preferable. See documentations for other functions. For example, |
|
@encukou, please take a look again. Is it look good enough now? |
erlend-aasland
approved these changes
Jan 4, 2025
Co-authored-by: Erlend E. Aasland <[email protected]>
erlend-aasland
approved these changes
Jan 6, 2025
|
Thanks @serhiy-storchaka for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jan 6, 2025
…yUnicode_FSDecoder (pythonGH-128451) (cherry picked from commit 657d7b7) Co-authored-by: Serhiy Storchaka <[email protected]> Co-authored-by: Stan Ulbrych <[email protected]> Co-authored-by: Erlend E. Aasland <[email protected]>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jan 6, 2025
…yUnicode_FSDecoder (pythonGH-128451) (cherry picked from commit 657d7b7) Co-authored-by: Serhiy Storchaka <[email protected]> Co-authored-by: Stan Ulbrych <[email protected]> Co-authored-by: Erlend E. Aasland <[email protected]>
|
GH-128542 is a backport of this pull request to the 3.13 branch. |
|
GH-128543 is a backport of this pull request to the 3.12 branch. |
serhiy-storchaka
added a commit
that referenced
this pull request
Jan 6, 2025
…PyUnicode_FSDecoder (GH-128451) (GH-128542) (cherry picked from commit 657d7b7) Co-authored-by: Serhiy Storchaka <[email protected]> Co-authored-by: Stan Ulbrych <[email protected]> Co-authored-by: Erlend E. Aasland <[email protected]>
serhiy-storchaka
added a commit
that referenced
this pull request
Jan 6, 2025
…PyUnicode_FSDecoder (GH-128451) (GH-128543) (cherry picked from commit 657d7b7) Co-authored-by: Serhiy Storchaka <[email protected]> Co-authored-by: Stan Ulbrych <[email protected]> Co-authored-by: Erlend E. Aasland <[email protected]>
srinivasreddy
pushed a commit
to srinivasreddy/cpython
that referenced
this pull request
Jan 8, 2025
…yUnicode_FSDecoder (pythonGH-128451) Co-authored-by: Stan Ulbrych <[email protected]> Co-authored-by: Erlend E. Aasland <[email protected]>
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.
📚 Documentation preview 📚: https://cpython-previews--128451.org.readthedocs.build/