Skip to content

Docs: Fix Sphinx warnings in io.rst #107903

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

Merged
erlend-aasland merged 12 commits into from
Aug 17, 2023
Merged

Docs: Fix Sphinx warnings in io.rst #107903

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
0f6bc74
Docs: Fix Sphinx warnings in io.rst
erlend-aasland Aug 12, 2023
58dbbad
Make sure to link to the correct subclasses
erlend-aasland Aug 13, 2023
2cebd39
Remove links from BufferedIOBase note
erlend-aasland Aug 13, 2023
41f95e5
remove extra dot
erlend-aasland Aug 13, 2023
c61ba2b
remove unneeded change
erlend-aasland Aug 13, 2023
6e49ca8
Revert unneeded change
erlend-aasland Aug 14, 2023
0784edd
Pull in main
erlend-aasland Aug 17, 2023
348c115
Markup read_text as a function
erlend-aasland Aug 17, 2023
3b84bfe
SEEK_HOLE and SEEK_DATA are now documented
erlend-aasland Aug 17, 2023
b4ed858
... and they still belong in os
erlend-aasland Aug 17, 2023
dcf4f8a
Pull in main
erlend-aasland Aug 17, 2023
52c873c
keep read_text() as it is!
erlend-aasland Aug 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Remove links from BufferedIOBase note
  • Loading branch information
@erlend-aasland
erlend-aasland committed Aug 13, 2023
commit 2cebd396d4f60c86fdd2ea3602233187ec583c61
2 changes: 1 addition & 1 deletion Doc/library/io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ standard stream implementations.
The abstract base classes also provide default implementations of some
methods in order to help implementation of concrete stream classes. For
example, :class:`BufferedIOBase` provides unoptimized implementations of
:meth:`~BufferedIOBase.readinto` and :meth:`~IOBase.readline`.
:meth:`!readinto` and :meth:`!readline`.

At the top of the I/O hierarchy is the abstract base class :class:`IOBase`. It
defines the basic interface to a stream. Note, however, that there is no
Expand Down