Skip to content

Wrong parameter name in http.client.read documentation: “amt” vs “n” #103112

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
Closed
bwagner opened this issue Mar 29, 2023 · 1 comment
Closed

Wrong parameter name in http.client.read documentation: “amt” vs “n” #103112

bwagner opened this issue Mar 29, 2023 · 1 comment
Labels
3.10 only security fixes 3.11 only security fixes 3.12 only security fixes stdlib Python modules in the Lib dir

Comments

@bwagner
Copy link
Contributor

bwagner commented Mar 29, 2023 •
edited by bedevere-bot
Loading

Documentation

`pydoc http.client.HTTPResponse.read``

results in help text:

http.client.HTTPResponse.read = read(self, amt=None)
    Read and return up to n bytes.

The parameter is called “amt” but the help text refers to “n”.

transferring the issue from discuss.python.org

Linked PRs
@bwagner bwagner added the docs Documentation in the Doc dir label Mar 29, 2023
@bwagner bwagner mentioned this issue Mar 29, 2023
Merged
@merwok merwok added stdlib Python modules in the Lib dir 3.11 only security fixes 3.10 only security fixes 3.12 only security fixes and removed docs Documentation in the Doc dir labels Mar 29, 2023
@terryjreedy
Copy link
Member

C.A.M. Gerlach diagnosed the issue as pydoc using a docstring from base class method BufferedIOBase.read(), with the fix being to add a docstring to this method.

terryjreedy added a commit that referenced this issue Mar 29, 2023
@bwagner @blurb-it
@terryjreedy @merwok
gh-103112: Add http.client.HTTPResponse.read docstring and fix pydoc …
d052a38 
…output (#103113)

Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <[email protected]>
Co-authored-by: Éric <[email protected]>
This was referenced Mar 29, 2023
Merged
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Mar 29, 2023
@bwagner @blurb-it
@terryjreedy @merwok @miss-islington
pythongh-103112: Add http.client.HTTPResponse.read docstring and fix …
2f108eb 
…pydoc output (pythonGH-103113)

(cherry picked from commit d052a38)

Co-authored-by: Bernhard Wagner <[email protected]>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <[email protected]>
Co-authored-by: Éric <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Mar 29, 2023
@bwagner @blurb-it
@terryjreedy @merwok @miss-islington
pythongh-103112: Add http.client.HTTPResponse.read docstring and fix …
a8c4377 
…pydoc output (pythonGH-103113)

(cherry picked from commit d052a38)

Co-authored-by: Bernhard Wagner <[email protected]>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <[email protected]>
Co-authored-by: Éric <[email protected]>
terryjreedy added a commit that referenced this issue Mar 29, 2023
@miss-islington @bwagner
@blurb-it @terryjreedy @merwok
[3.11] gh-103112: Add http.client.HTTPResponse.read docstring and fix…
ae42c1d 
… pydoc output (GH-103113) (#103119)

(cherry picked from commit d052a38)

Co-authored-by: Bernhard Wagner <[email protected]>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <[email protected]>
Co-authored-by: Éric <[email protected]>
terryjreedy added a commit that referenced this issue Mar 29, 2023
@miss-islington @bwagner
@blurb-it @terryjreedy @merwok
[3.10] gh-103112: Add http.client.HTTPResponse.read docstring and fix…
3a27be7 
… pydoc output (GH-103113) (#103120)

(cherry picked from commit d052a38)

Co-authored-by: Bernhard Wagner <[email protected]>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <[email protected]>
Co-authored-by: Éric <[email protected]>
warsaw pushed a commit to warsaw/cpython that referenced this issue Apr 11, 2023
@bwagner @blurb-it
@terryjreedy @merwok @warsaw
pythongh-103112: Add http.client.HTTPResponse.read docstring and fix …
09c7fd7 
…pydoc output (python#103113)

Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <[email protected]>
Co-authored-by: Éric <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
3.10 only security fixes 3.11 only security fixes 3.12 only security fixes stdlib Python modules in the Lib dir
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@bwagner @merwok @terryjreedy