GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — gh-103112: Add http.client.HTTPResponse.read docstring and fix pydoc output by bwagner · Pull Request #103113 · python/cpython

Conversation

bwagner commented Mar 29, 2023 •

edited by bedevere-bot

Loading

Uh oh!

There was an error while loading. Please reload this page.

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

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions


          FIXES: documentation of read, Parameter amt

5acbc64

https://discuss.python.org/t/wrong-parameter-name-in-http-client-read-documentation-amt-vs-n/25284/3?u=bwagner

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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

ghost commented Mar 29, 2023 •

edited by ghost

Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link

Copy Markdown

All commit authors signed the Contributor License Agreement.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.


          📜🤖 Added by blurb_it.

4a0c2f3

bedevere-bot mentioned this pull request

Mar 29, 2023

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

Closed

merwok added needs backport to 3.10 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

terryjreedy reviewed

Mar 29, 2023

View reviewed changes

Comment thread

Lib/http/client.py Resolved

Uh oh!

There was an error while loading. Please reload this page.


          Update Lib/http/client.py

43948c8

terryjreedy reviewed

Mar 29, 2023

View reviewed changes

Comment thread

Misc/NEWS.d/next/Documentation/2023-03-29-14-51-39.gh-issue-103112.XgGSEO.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.


          Update Misc/NEWS.d/next/Documentation/2023-03-29-14-51-39.gh-issue-10…

264e89f

…3112.XgGSEO.rst

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

terryjreedy reviewed

Mar 29, 2023

View reviewed changes

Comment thread

Misc/NEWS.d/next/Documentation/2023-03-29-14-51-39.gh-issue-103112.XgGSEO.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.


          Update Misc/NEWS.d/next/Documentation/2023-03-29-14-51-39.gh-issue-10…

34b17ef

…3112.XgGSEO.rst

merwok reviewed

Mar 29, 2023

View reviewed changes

Comment thread

Lib/http/client.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

merwok reviewed

Mar 29, 2023

View reviewed changes

Comment thread

Misc/NEWS.d/next/Documentation/2023-03-29-14-51-39.gh-issue-103112.XgGSEO.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

terryjreedy and others added 2 commits

March 29, 2023 13:21


          Update Lib/http/client.py

e458c0a

Co-authored-by: Éric <[email protected]>


          Update Misc/NEWS.d/next/Documentation/2023-03-29-14-51-39.gh-issue-10…

496de75

…3112.XgGSEO.rst

Co-authored-by: Éric <[email protected]>

terryjreedy commented Mar 29, 2023

Copy link

Copy Markdown

Member

I visually verified both the issue and the fix.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

terryjreedy reviewed

Mar 29, 2023

View reviewed changes

Comment thread

Misc/NEWS.d/next/Documentation/2023-03-29-14-51-39.gh-issue-103112.XgGSEO.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.


          Update Misc/NEWS.d/next/Documentation/2023-03-29-14-51-39.gh-issue-10…

8bd94e3

…3112.XgGSEO.rst

terryjreedy commented Mar 29, 2023

Copy link

Copy Markdown

Member

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

merwok commented Mar 29, 2023

Copy link

Copy Markdown

Member

Ah it’s program not cmd!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

terryjreedy merged commit d052a38 into python:main

Mar 29, 2023

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.
🐍🍒⛏🤖

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-bot commented Mar 29, 2023

Copy link

Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-bot removed the needs backport to 3.11 only security fixes label

Mar 29, 2023

bedevere-bot commented Mar 29, 2023

Copy link

Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-bot removed the needs backport to 3.10 label

Mar 29, 2023

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request

Mar 29, 2023


          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


          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


          [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


          [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


          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 mentioned this pull request

Aug 10, 2023

ctypes: Add docstring for ctypes.Array #107689

Closed

Reviewers

merwok

merwok left review comments

terryjreedy

terryjreedy left review comments

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

stdlib

Standard Library Python modules in the Lib/ directory

type-bug

An unexpected behavior, bug, or error

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.

GeezerVison

Conversation

bwagner commented Mar 29, 2023 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bedevere-bot commented Mar 29, 2023

Uh oh!

ghost commented Mar 29, 2023 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

terryjreedy commented Mar 29, 2023

Uh oh!

Uh oh!

terryjreedy commented Mar 29, 2023

Uh oh!

merwok commented Mar 29, 2023

Uh oh!

miss-islington commented Mar 29, 2023

Uh oh!

bedevere-bot commented Mar 29, 2023

Uh oh!

bedevere-bot commented Mar 29, 2023

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

bwagner commented Mar 29, 2023 •

edited by bedevere-bot

Loading

Uh oh!

There was an error while loading. Please reload this page.

ghost commented Mar 29, 2023 •

edited by ghost

Loading

Uh oh!

There was an error while loading. Please reload this page.