Docs: Fix Sphinx warnings in io.rst #107903
Merged
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
erlend-aasland
added
skip issue
skip news
needs backport to 3.11
AA-Turner
reviewed
Aug 13, 2023
Doc/library/io.rst
Outdated
| @@ -215,7 +215,7 @@ High-level Module Interface | |||
| return f.read() | |||
|
|
|||
| In this example, an :class:`EncodingWarning` is emitted for the caller of | |||
| ``read_text()``. | |||
| :meth:`!read_text`. | |||
There was a problem hiding this comment.
I think this should stay as read_text(); it refers to the exemplar function defined immediatley above and not to any object description.
Suggested change
| :meth:`!read_text`. | |
| ``read_text()`` |
There was a problem hiding this comment.
I agree. I had an earlier variant where I converted these to the meth markup, but I changed my mind. Probably forgot to revert this one. Thanks for noticing.
There was a problem hiding this comment.
Did you change your mind on this one? xref 348c115
Co-authored-by: Adam Turner <[email protected]>
|
Let's land some of the other changes first; for example documenting |
AA-Turner
approved these changes
Aug 17, 2023
|
Thanks for the review! |
|
Thanks @erlend-aasland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
|
GH-108093 is a backport of this pull request to the 3.12 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Aug 17, 2023
- Mark up parameter and argument names properly - If possible, link to docs for methods like `seek`, `tell`, `write`, `read`, etc. (cherry picked from commit 5c76899) Co-authored-by: Erlend E. Aasland <[email protected]> Co-authored-by: Adam Turner <[email protected]>
|
GH-108094 is a backport of this pull request to the 3.11 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Aug 17, 2023
- Mark up parameter and argument names properly - If possible, link to docs for methods like `seek`, `tell`, `write`, `read`, etc. (cherry picked from commit 5c76899) Co-authored-by: Erlend E. Aasland <[email protected]> Co-authored-by: Adam Turner <[email protected]>
erlend-aasland
added a commit
that referenced
this pull request
Aug 17, 2023
- Mark up parameter and argument names properly - If possible, link to docs for methods like `seek`, `tell`, `write`, `read`, etc. (cherry picked from commit 5c76899) Co-authored-by: Erlend E. Aasland <[email protected]> Co-authored-by: Adam Turner <[email protected]>
Yhg1s
added a commit
that referenced
this pull request
Aug 18, 2023
Docs: Fix Sphinx warnings in io.rst (GH-107903) - Mark up parameter and argument names properly - If possible, link to docs for methods like `seek`, `tell`, `write`, `read`, etc. (cherry picked from commit 5c76899) Co-authored-by: Erlend E. Aasland <[email protected]> Co-authored-by: Adam Turner <[email protected]> Co-authored-by: T. Wouters <[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.
seek,tell,write,read, etc. Else, remove the (already dead) link.📚 Documentation preview 📚: https://cpython-previews--107903.org.readthedocs.build/