Skip to content

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

Closed
Closed
Wrong parameter name in http.client.read documentation: “amt” vs “n”#103112
Labels
3.10 (EOL)end of life3.11only security fixes3.12only security fixesstdlibStandard Library Python modules in the Lib/ directory

Description

@bwagner
bwagner
opened on Mar 29, 2023

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

Activity

  1. bwagner
    added
    docsDocumentation in the Doc dir
    on Mar 29, 2023
  2. merwok
    added
    stdlibStandard Library Python modules in the Lib/ directory
    3.11only security fixes
    3.10 (EOL)end of life
    3.12only security fixes
    and removed
    docsDocumentation in the Doc dir
    on Mar 29, 2023

  3. terryjreedy commented on Mar 29, 2023

    @terryjreedy
    terryjreedy
    on Mar 29, 2023
    Member

    C.A.M. Gerlach diagnosed the issue as pydoc using a docstring from base class method BufferedIOBase.read(), with the fix being to add a docstring to this method.

  4. terryjreedy
    added a commit that references this issue on Mar 29, 2023

    gh-103112: Add http.client.HTTPResponse.read docstring and fix pydoc …

    d052a38
  5. miss-islington
    added 2 commits that reference this issue on Mar 29, 2023

    pythongh-103112: Add http.client.HTTPResponse.read docstring and fix …

    2f108eb

    pythongh-103112: Add http.client.HTTPResponse.read docstring and fix …

    a8c4377
  6. terryjreedy
    added 2 commits that reference this issue on Mar 29, 2023

    [3.11] gh-103112: Add http.client.HTTPResponse.read docstring and fix…

    ae42c1d

    [3.10] gh-103112: Add http.client.HTTPResponse.read docstring and fix…

    3a27be7
  7. terryjreedy
    closed this as completedon Mar 29, 2023
  8. warsaw
    added a commit that references this issue on Apr 11, 2023

    pythongh-103112: Add http.client.HTTPResponse.read docstring and fix …

    09c7fd7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    3.10 (EOL)end of life3.11only security fixes3.12only security fixesstdlibStandard Library Python modules in the Lib/ directory

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions