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

There is a typo in docstring for read method of _io.TextIOWrapper class #101228

Closed
ppmfloss opened this issue Jan 22, 2023 · 0 comments
Closed

There is a typo in docstring for read method of _io.TextIOWrapper class #101228

ppmfloss opened this issue Jan 22, 2023 · 0 comments
Labels
docs Documentation in the Doc dir

Comments

@ppmfloss
Copy link
Contributor

ppmfloss commented Jan 22, 2023 •
edited
Loading

Documentation

The docstring of the read method of _io.TextIOWrapper class has a typo.
The argument name size is not used in the explanation.

>>> file = open("/tmp/junk")
>>> help(file.read)

read(size=-1, /) method of _io.TextIOWrapper instance
    Read at most n characters from stream.
    
    Read from underlying buffer until we have n characters or we hit EOF.
    If n is negative or omitted, read until EOF.

Linked PRs
@ppmfloss ppmfloss added the docs Documentation in the Doc dir label Jan 22, 2023
@bedevere-bot bedevere-bot mentioned this issue Jan 22, 2023
Merged
kumaraditya303 pushed a commit that referenced this issue Feb 9, 2023
@ppmfloss
GH-101228: Fix typo in docstring for read method of `_io.TextIOWrappe…
f1f3af7 
…r` class (#101227)
carljm added a commit to carljm/cpython that referenced this issue Feb 10, 2023
@carljm
Merge branch 'main' into inlinecomp2
add772e 
* main:
  Fix some typos in asdl_c.py (pythonGH-101757)
  pythongh-101747: Fix refleak in new `OrderedDict` repr (pythonGH-101748)
  pythongh-101430: Update tracemalloc to handle presize properly. (pythongh-101745)
  pythonGH-101228: Fix typo in docstring for read method of `_io.TextIOWrapper` class (python#101227)
  Fix typo in `test_fstring.py` (python#101600)
  pythongh-101726: Update the OpenSSL version to 1.1.1t (pythonGH-101727)
  pythongh-101283: Fix 'versionchanged' for the shell=True fallback on Windows in 3.12 (pythonGH-101728)
  LibFFI build requires x64 Cygwin, and skip the ARM build (pythonGH-101743)
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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ppmfloss @kumaraditya303