Skip to content

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

Merged
terryjreedy merged 8 commits into
python:mainfrom
bwagner:fixes-httpclient-read-documentation
Mar 29, 2023
Merged

gh-103112: Add http.client.HTTPResponse.read docstring and fix pydoc output#103113
terryjreedy merged 8 commits into
python:mainfrom
bwagner:fixes-httpclient-read-documentation

Conversation

@bwagner

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

Copy link
Copy Markdown
Contributor

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

bedevere-bot commented Mar 29, 2023

Copy link
Copy Markdown

Most changes to Python require a NEWS entry.

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

@ghost

ghost commented Mar 29, 2023•
edited by ghost
Loading

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-botbedevere-bot mentioned this pull request Mar 29, 2023
Closed
@merwokmerwok added needs backport to 3.10 only security fixes stdlib Standard Library Python modules in the Lib/ directory needs backport to 3.11 only security fixes labels Mar 29, 2023
@terryjreedyterryjreedy added the type-bug An unexpected behavior, bug, or error label Mar 29, 2023
terryjreedy
terryjreedy reviewed Mar 29, 2023
View reviewed changes
Comment threadLib/http/client.py Outdated
terryjreedy
terryjreedy reviewed Mar 29, 2023
View reviewed changes
Comment threadMisc/NEWS.d/next/Documentation/2023-03-29-14-51-39.gh-issue-103112.XgGSEO.rst Outdated
@terryjreedyterryjreedy changed the title gh-103112: documentation of http.client.HTTPResponse.read, Parameter amtgh-103112: Add http.client.HTTPResponse.read docstring and fix pydoc outputMar 29, 2023
terryjreedy
terryjreedy reviewed Mar 29, 2023
View reviewed changes
Comment threadMisc/NEWS.d/next/Documentation/2023-03-29-14-51-39.gh-issue-103112.XgGSEO.rst Outdated
merwok
merwok reviewed Mar 29, 2023
View reviewed changes
Comment threadLib/http/client.py Outdated
merwok
merwok reviewed Mar 29, 2023
View reviewed changes
Comment threadMisc/NEWS.d/next/Documentation/2023-03-29-14-51-39.gh-issue-103112.XgGSEO.rst Outdated
terryjreedyand others added 2 commits March 29, 2023 13:21
@terryjreedy@merwok
Update Lib/http/client.py
e458c0a
Co-authored-by: Éric <merwok@netwok.org>
@terryjreedy@merwok
Update Misc/NEWS.d/next/Documentation/2023-03-29-14-51-39.gh-issue-10…
496de75
…3112.XgGSEO.rst
Co-authored-by: Éric <merwok@netwok.org>
@terryjreedy

terryjreedy commented Mar 29, 2023

Copy link
Copy Markdown
Member

I visually verified both the issue and the fix.

terryjreedy
terryjreedy reviewed Mar 29, 2023
View reviewed changes
Comment threadMisc/NEWS.d/next/Documentation/2023-03-29-14-51-39.gh-issue-103112.XgGSEO.rst Outdated
@terryjreedy

terryjreedy commented Mar 29, 2023

Copy link
Copy Markdown
Member

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

@merwok

merwok commented Mar 29, 2023

Copy link
Copy Markdown
Member

Ah it’s program not cmd!

@terryjreedy
terryjreedy merged commit d052a38 into python:mainMar 29, 2023
@miss-islington

miss-islington commented Mar 29, 2023

Copy link
Copy Markdown
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

bedevere-bot commented Mar 29, 2023

Copy link
Copy Markdown

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

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

bedevere-bot commented Mar 29, 2023

Copy link
Copy Markdown

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

@bedevere-botbedevere-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 <github.comNotification20120125@xmlizer.net>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Éric <merwok@netwok.org>
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 <github.comNotification20120125@xmlizer.net>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Éric <merwok@netwok.org>
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 <github.comNotification20120125@xmlizer.net>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Éric <merwok@netwok.org>
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 <github.comNotification20120125@xmlizer.net>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Éric <merwok@netwok.org>
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 <tjreedy@udel.edu>
Co-authored-by: Éric <merwok@netwok.org>
@tomasr8tomasr8 mentioned this pull request Aug 10, 2023
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@merwokmerwokmerwok left review comments
@terryjreedyterryjreedyterryjreedy left review comments

Assignees

No one assigned

Labels

stdlibStandard Library Python modules in the Lib/ directorytype-bugAn 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