Skip to content

gh-103112: Add http.client.HTTPResponse.read docstring and fix pydoc output #103113

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
Merged
merged 8 commits into from
Mar 29, 2023
Merged

gh-103112: Add http.client.HTTPResponse.read docstring and fix pydoc output #103113

merged 8 commits into from
Mar 29, 2023

Conversation

bwagner
Copy link
Contributor

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

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”.

Issue 103112
Discussion

@bedevere-bot
Copy link

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

@ghost
Copy link

ghost commented Mar 29, 2023 •
edited by ghost
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-bot bedevere-bot mentioned this pull request Mar 29, 2023
Closed
@merwok merwok added needs backport to 3.10 only security fixes stdlib Python modules in the Lib dir needs backport to 3.11 only security fixes labels Mar 29, 2023
@terryjreedy terryjreedy added the type-bug An unexpected behavior, bug, or error label Mar 29, 2023
terryjreedy
terryjreedy reviewed Mar 29, 2023
View reviewed changes
@terryjreedy terryjreedy changed the title gh-103112: documentation of http.client.HTTPResponse.read, Parameter amt gh-103112: Add http.client.HTTPResponse.read docstring and fix pydoc output Mar 29, 2023
merwok
merwok reviewed Mar 29, 2023
View reviewed changes
@terryjreedy
Copy link
Member

I visually verified both the issue and the fix.

@terryjreedy
Copy link
Member

@merwok Failures because 'cmd' is not a known role. I removed it.

@merwok
Copy link
Member

merwok commented Mar 29, 2023

Ah it’s program not cmd!

@terryjreedy terryjreedy merged commit d052a38 into python:main Mar 29, 2023
@miss-islington
Copy link
Contributor

Thanks @bwagner for the PR, and @terryjreedy for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-103119 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Mar 29, 2023
@bedevere-bot
Copy link

GH-103120 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Mar 29, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request 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 pull request 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 pull request 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 pull request 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 pull request 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]>
@tomasr8 tomasr8 mentioned this pull request Aug 10, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@merwok merwok merwok left review comments

@terryjreedy terryjreedy terryjreedy left review comments

Assignees
No one assigned
Labels
stdlib Python modules in the Lib dir type-bug An unexpected behavior, bug, or error
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@bwagner @bedevere-bot @terryjreedy @merwok @miss-islington