GV

GeezerVison

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

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Wrong parameter name in http.client.read documentation: “amt” vs “n” · Issue #103112 · python/cpython

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.10 (EOL)end of lifeend of life3.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
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

Activity

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

  3. terryjreedy commented on Mar 29, 2023

    @terryjreedy
    terryjreedy
    on Mar 29, 2023
    Member
    More actions

    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 lifeend of life3.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
      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.