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

New issue

Copy link

New issue

Copy link

Closed

Closed

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

Copy link

Labels

3.10only security fixesonly security fixes3.11only security fixesonly security fixes3.12only security fixesonly security fixesstdlibStandard Library Python modules in the Lib/ directoryStandard Library Python modules in the Lib/ directory

Description

bwagner

opened on Mar 29, 2023

Issue body actions

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

• gh-103112: Add http.client.HTTPResponse.read docstring and fix pydoc output #103113
• [3.11] gh-103112: Add http.client.HTTPResponse.read docstring and fix pydoc output (GH-103113) #103119
• [3.10] gh-103112: Add http.client.HTTPResponse.read docstring and fix pydoc output (GH-103113) #103120

Reactions are currently unavailable

Metadata

Metadata

Assignees

No one assigned

Labels

3.10only security fixesonly security fixes3.11only security fixesonly security fixes3.12only security fixesonly security fixesstdlibStandard Library Python modules in the Lib/ directoryStandard Library Python modules in the Lib/ directory

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions