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 — There is a typo in docstring for read method of _io.TextIOWrapper class · Issue #101228 · python/cpython

There is a typo in docstring for read method of _io.TextIOWrapper class #101228

New issue
Copy link
New issue
Copy link
Closed
Closed
There is a typo in docstring for read method of _io.TextIOWrapper class#101228
Copy link
Labels
docsDocumentation in the Doc dirDocumentation in the Doc dir

Description

@ppmfloss
ppmfloss
opened on Jan 22, 2023
Issue body actions

Documentation

The docstring of the read method of _io.TextIOWrapper class has a typo.
The argument name size is not used in the explanation.

>>> file = open("/tmp/junk")
>>> help(file.read)

read(size=-1, /) method of _io.TextIOWrapper instance
    Read at most n characters from stream.
    
    Read from underlying buffer until we have n characters or we hit EOF.
    If n is negative or omitted, read until EOF.

Linked PRs

  • GH-101228: Fix typo in docstring for read method of _io.TextIOWrapper class #101227

Activity

  1. ppmfloss
    added
    docsDocumentation in the Doc dirDocumentation in the Doc dir
    on Jan 22, 2023
  2. kumaraditya303
    added a commit that references this issue on Feb 9, 2023

    GH-101228: Fix typo in docstring for read method of `_io.TextIOWrappe…

    f1f3af7
  3. kumaraditya303
    closed this as completedon Feb 9, 2023
  4. carljm
    added a commit that references this issue on Feb 10, 2023

    Merge branch 'main' into inlinecomp2

    add772e
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

    docsDocumentation in the Doc dirDocumentation in the Doc dir

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions
      You are visitor 01402503 — 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.