Skip to content

Patch to add docstrings to msvcrt #51828

Closed

Description

@briancurtin
BPO 7579
Nosy @birkenfeld, @amauryfa, @briancurtin
Files
  • msvcrt_docstrings.diff: Patch against r77057 trunk
  • msvcrt_docstrings_v2.diff: Updated patch with Amaury's comments
  • issue7579_py3k.diff: Patch against py3k r77150
  • Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = 'https://github.com/briancurtin'
    closed_at = <Date 2010-08-24.05:20:55.844>
    created_at = <Date 2009-12-26.21:29:28.394>
    labels = ['type-bug', 'OS-windows', 'docs']
    title = 'Patch to add docstrings to msvcrt'
    updated_at = <Date 2010-08-24.05:20:55.842>
    user = 'https://github.com/briancurtin'

    bugs.python.org fields:

    activity = <Date 2010-08-24.05:20:55.842>
    actor = 'brian.curtin'
    assignee = 'brian.curtin'
    closed = True
    closed_date = <Date 2010-08-24.05:20:55.844>
    closer = 'brian.curtin'
    components = ['Documentation', 'Windows']
    creation = <Date 2009-12-26.21:29:28.394>
    creator = 'brian.curtin'
    dependencies = []
    files = ['15676', '15684', '15704']
    hgrepos = []
    issue_num = 7579
    keywords = ['patch']
    message_count = 7.0
    messages = ['96893', '96932', '96950', '97007', '97014', '97060', '114769']
    nosy_count = 4.0
    nosy_names = ['georg.brandl', 'amaury.forgeotdarc', 'brian.curtin', 'docs@python']
    pr_nums = []
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = 'behavior'
    url = 'https://bugs.python.org/issue7579'
    versions = ['Python 2.7', 'Python 3.2']

    Activity

    1. briancurtin commented on Dec 26, 2009

      @briancurtin
      MemberAuthor

      Patch to provide docstrings throughout the msvcrt module.

    2. amauryfa commented on Dec 28, 2009

      @amauryfa
      Contributor

      This is a good idea. I have some comments though:

      • the second docstring says "heapmin" when it should describe "locking".
      • there are strange characters around "pushed back". Please use only ascii
        characters.
      • The body of the docstrings should be split into separate lines. the
        ending ' \' should be replaced by with '\n\' (see Python/sysmodule.c, for
        example)
    3. briancurtin commented on Dec 28, 2009

      @briancurtin
      MemberAuthor

      I fixed up the bodies of the docstrings, removed the weird quotes around
      "pushed back" (copy/paste error), and got the heapmin/locking name fixed up.

      Thanks for taking a look at this.

    4. birkenfeld commented on Dec 29, 2009

      @birkenfeld
      Member

      Patch looks good, can someone with the ability to test it please commit it?

    5. amauryfa commented on Dec 29, 2009

      @amauryfa
      Contributor

      Committed r77126 in trunk.
      I reflowed the text for getch(), so that help(msvcrt) displays nicely in a
      80-chars-wide console (this was my "test")

      I was about to merge it into py3k, when I realized that the documentation
      should be updated to match the str/bytes distinction.
      Can someone suggest a patch for py3k? (and for Doc/library/msvcrt.rst as
      well)

    6. briancurtin commented on Dec 30, 2009

      @briancurtin
      MemberAuthor

      Here is a patch for py3k. It uses the same contents as before but with
      changes to the str/bytes wording on getch_doc, putch_doc, and
      ungetch_doc. Includes updates to the msvcrt.rst file. Let me know if the
      wording seems correct (or if I left anything out).

      I went ahead and added docstrings to the debug-only functions as a bonus.

    7. briancurtin commented on Aug 24, 2010

      @briancurtin
      MemberAuthor

      Committed to py3k in r84295.

    8. transferred this issue fromon Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Metadata

    Assignees

    Labels

    OS-windowsdocsDocumentation in the Doc dirtype-bugAn unexpected behavior, bug, or error

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions