Skip to content
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

Jump to bottom

https://docs.python.org/3/library/io.html#class-hierarchy mis-orders the the BufferedIOBase subclasses explanation. #95691

Closed
dougmiller opened this issue Aug 5, 2022 · 0 comments · Fixed by #95703
Closed

https://docs.python.org/3/library/io.html#class-hierarchy mis-orders the the BufferedIOBase subclasses explanation. #95691

dougmiller opened this issue Aug 5, 2022 · 0 comments · Fixed by #95703
Labels
docs Documentation in the Doc dir topic-IO

Comments

@dougmiller
Copy link

Documentation

"Its subclasses, BufferedWriter, BufferedReader, and BufferedRWPair buffer raw binary streams that are readable, writable, and both readable and writable, respectively."

Does this mean that the BufferedWriter is readable, the BufferedReader is writeable?

Surely it should be:

"Its subclasses, BufferedWriter, BufferedReader, and BufferedRWPair buffer raw binary streams that are writable, readable, and both readable** and writable, respectively."
@dougmiller dougmiller added the docs Documentation in the Doc dir label Aug 5, 2022
180909 added a commit to 180909/cpython that referenced this issue Aug 5, 2022
@180909
pythongh-95691: Doc BufferedWriter and BufferedReader
7b292e4
@180909 180909 mentioned this issue Aug 5, 2022
Merged
nanjekyejoannah pushed a commit that referenced this issue Oct 5, 2022
@180909
gh-95691: Doc BufferedWriter and BufferedReader (#95703)
0d68879
@bedevere-bot bedevere-bot mentioned this issue Oct 5, 2022
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 5, 2022
@180909 @miss-islington
pythongh-95691: Doc BufferedWriter and BufferedReader (pythonGH-95703)
3bb6545 
(cherry picked from commit 0d68879)

Co-authored-by: 180909 <734461790@qq.com>
@bedevere-bot bedevere-bot mentioned this issue Oct 5, 2022
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 5, 2022
@180909 @miss-islington
pythongh-95691: Doc BufferedWriter and BufferedReader (pythonGH-95703)
4bfe632 
(cherry picked from commit 0d68879)

Co-authored-by: 180909 <734461790@qq.com>
nanjekyejoannah pushed a commit that referenced this issue Oct 6, 2022
@miss-islington @180909
[3.11] gh-95691: Doc BufferedWriter and BufferedReader (GH-95703) (#9…
1144cf6 
…7947)

gh-95691: Doc BufferedWriter and BufferedReader (GH-95703)
(cherry picked from commit 0d68879)

Co-authored-by: 180909 <734461790@qq.com>

Co-authored-by: 180909 <734461790@qq.com>
nanjekyejoannah pushed a commit that referenced this issue Oct 6, 2022
@miss-islington @180909
[3.10] gh-95691: Doc BufferedWriter and BufferedReader (GH-95703) (#9…
e2591e4 
…7948)

gh-95691: Doc BufferedWriter and BufferedReader (GH-95703)
(cherry picked from commit 0d68879)

Co-authored-by: 180909 <734461790@qq.com>

Co-authored-by: 180909 <734461790@qq.com>
carljm added a commit to carljm/cpython that referenced this issue Oct 6, 2022
@carljm
Merge branch 'main' into dictwatch
7938d6f 
* main:
  pythonGH-88050: fix race in closing subprocess pipe in asyncio  (python#97951)
  pythongh-93738: Disallow pre-v3 syntax in the C domain (python#97962)
  pythongh-95986: Fix the example using match keyword (python#95989)
  pythongh-97897: Prevent os.mkfifo and os.mknod segfaults with macOS 13 SDK (pythonGH-97944)
  pythongh-94808: Cover `PyUnicode_Count` in CAPI (python#96929)
  pythongh-94808: Cover `PyObject_PyBytes` case with custom `__bytes__` method (python#96610)
  pythongh-95691: Doc BufferedWriter and BufferedReader (python#95703)
  pythonGH-88968: Add notes about socket ownership transfers (python#97936)
  pythongh-96865: [Enum] fix Flag to use CONFORM boundary (pythonGH-97528)
carljm added a commit to carljm/cpython that referenced this issue Oct 8, 2022
@carljm
Merge branch 'main' into typewatch
1af2a98 
* main: (53 commits)
  pythongh-94808: Coverage: Test that maximum indentation level is handled (python#95926)
  pythonGH-88050: fix race in closing subprocess pipe in asyncio  (python#97951)
  pythongh-93738: Disallow pre-v3 syntax in the C domain (python#97962)
  pythongh-95986: Fix the example using match keyword (python#95989)
  pythongh-97897: Prevent os.mkfifo and os.mknod segfaults with macOS 13 SDK (pythonGH-97944)
  pythongh-94808: Cover `PyUnicode_Count` in CAPI (python#96929)
  pythongh-94808: Cover `PyObject_PyBytes` case with custom `__bytes__` method (python#96610)
  pythongh-95691: Doc BufferedWriter and BufferedReader (python#95703)
  pythonGH-88968: Add notes about socket ownership transfers (python#97936)
  pythongh-96865: [Enum] fix Flag to use CONFORM boundary (pythonGH-97528)
  pythongh-65961: Raise `DeprecationWarning` when `__package__` differs from `__spec__.parent` (python#97879)
  docs(typing): add "see PEP 675" to LiteralString (python#97926)
  pythongh-97850: Remove all known instances of module_repr() (python#97876)
  I changed my surname early this year (python#96671)
  pythongh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (python#97768)
  pythongh-91539: improve performance of get_proxies_environment  (python#91566)
  build(deps): bump actions/stale from 5 to 6 (python#97701)
  pythonGH-95172 Make the same version `versionadded` oneline (python#95172)
  pythongh-88050: Fix asyncio subprocess to kill process cleanly when process is blocked (python#32073)
  pythongh-93738: Documentation C syntax (Function glob patterns -> literal markup) (python#97774)
  ...
mpage pushed a commit to mpage/cpython that referenced this issue Oct 11, 2022
@180909 @mpage
pythongh-95691: Doc BufferedWriter and BufferedReader (python#95703)
97a27d8
pablogsal pushed a commit that referenced this issue Oct 22, 2022
@miss-islington @180909 @pablogsal
[3.11] gh-95691: Doc BufferedWriter and BufferedReader (GH-95703) (#9…
508ef0f 
…7947)

gh-95691: Doc BufferedWriter and BufferedReader (GH-95703)
(cherry picked from commit 0d68879)

Co-authored-by: 180909 <734461790@qq.com>

Co-authored-by: 180909 <734461790@qq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir topic-IO
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

gh-95691: Doc BufferedWriter and BufferedReader 180909/cpython
2 participants
@dougmiller @AlexWaygood