FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-103112: Add http.client.HTTPResponse.read docstring and fix pydoc output by bwagner · Pull Request #103113 · python/cpython · GitHub

/ cpython Public

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

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 commented Mar 29, 2023
edited by ghost
Loading

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

merwok 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
terryjreedy added the type-bug An unexpected behavior, bug, or error label Mar 29, 2023
Comment thread Lib/http/client.py Outdated
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
Comment thread Lib/http/client.py Outdated
terryjreedy and others added 2 commits March 29, 2023 13:21
Co-authored-by: Éric <merwok@netwok.org>
…3112.XgGSEO.rst

Co-authored-by: Éric <merwok@netwok.org>

Copy link
Copy Markdown
Member

I visually verified both the issue and the fix.

Copy link
Copy Markdown
Member

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

merwok commented Mar 29, 2023

Copy link
Copy Markdown
Member

Ah it’s program not cmd!

terryjreedy merged commit d052a38 into python:main 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.
🐍🍒⛏🤖

Copy link
Copy Markdown

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

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

Copy link
Copy Markdown

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

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
…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
…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
… 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
… 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
…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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

stdlib Standard Library Python modules in the Lib/ directory type-bug An unexpected behavior, bug, or error

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants


Back | FazBrowse Home | New Git URL