Skip to content

Typos in docs and code comments #80947

Closed
Closed

Description

@tirkarthi
BPO 36766
Nosy @terryjreedy, @matrixise, @Mariatta, @csabella, @miss-islington, @tirkarthi, @penguindustin
PRs
  • bpo-36766: Typos in docs and code comments #13116
  • [3.7] bpo-36766: Typos in docs and code comments (GH-13116). #13136
  • 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/Mariatta'
    closed_at = <Date 2019-05-06.21:07:07.063>
    created_at = <Date 2019-05-01.13:12:27.296>
    labels = ['3.8', 'type-bug', '3.7', 'docs']
    title = 'Typos in docs and code comments'
    updated_at = <Date 2019-05-06.21:07:07.060>
    user = 'https://github.com/tirkarthi'

    bugs.python.org fields:

    activity = <Date 2019-05-06.21:07:07.060>
    actor = 'terry.reedy'
    assignee = 'Mariatta'
    closed = True
    closed_date = <Date 2019-05-06.21:07:07.063>
    closer = 'terry.reedy'
    components = ['Documentation']
    creation = <Date 2019-05-01.13:12:27.296>
    creator = 'xtreak'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 36766
    keywords = ['patch']
    message_count = 7.0
    messages = ['341194', '341528', '341603', '341613', '341622', '341646', '341648']
    nosy_count = 7.0
    nosy_names = ['terry.reedy', 'matrixise', 'Mariatta', 'cheryl.sabella', 'miss-islington', 'xtreak', 'Giant_Robato']
    pr_nums = ['13116', '13136']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = 'behavior'
    url = 'https://bugs.python.org/issue36766'
    versions = ['Python 3.7', 'Python 3.8']

    Activity

    1. tirkarthi commented on May 1, 2019

      @tirkarthi
      MemberAuthor

      I ran aspell through the files and found below to be typos while manually filtering the aspell output. I have classified it into sections since I am not sure if code comments are worth fixing and added relevant files where they are present. I am tagging the issue for PyCon US dev sprints. Please don't make a PR for this if you have already contributed a PR.

      # Docs folder

      Cotnent -> Content-Transfer-Encoding (Doc/library/email.generator.rst)
      attibute -> attribute (Doc/library/pyclbr.rst)
      milleseconds -> milliseconds (Doc/library/idle.rst)

      # Code comments

      actuall -> actual (Lib/test/test_dataclasses.py)
      actully -> actually (Lib/contextlib.py)
      agains -> against (Lib/pathlib.py)
      Amerian -> American (Lib/test/test_random.py)
      Conflic -> Conflict (Lib/idlelib/idle_test/test_config.py)
      Depedent -> Dependent (Lib/test/datetimetester.py)
      Diffent -> Different (Lib/test/support/init.py)
      Diplay -> Display (Objects/object.c)
      Doens't -> Doesn't (Lib/test/test_ssl.py)
      Dono't -> Don't (Lib/test/test_importlib/test_lazy.py)
      intermitted -> intermittent (Lib/test/pickletester.py)
      invokation -> Invocation (Lib/platform.py)
      occuring -> occurring (Lib/test/test_tools/test_i18n.py)
      permuations -> permutations (Lib/tokenize.py)
      resouce -> resource (Lib/multiprocessing/resource_sharer.py)
      statists -> statistics (Lib/pstats.py)

      # Docstring

      Dafault -> Default (Lib/turtle.py)
      Diplay -> Display (Lib/idlelib/help.py)
      Intput -> Input (Lib/lib2to3/pgen2/tokenize.py)
      milleseconds -> milliseconds (Lib/idlelib/configdialog.py, Lib/idlelib/help.html)

    2. added
      docsDocumentation in the Doc dir
      type-bugAn unexpected behavior, bug, or error
      on May 1, 2019
    3. penguindustin commented on May 6, 2019

      penguindustinmannequin
      Mannequin

      I'd like to work on this for the mentored Sprints

    4. matrixise commented on May 6, 2019

      @matrixise
      Member

      New changeset 9646630 by Stéphane Wirtel (penguindustin) in branch 'master':
      bpo-36766: Typos in docs and code comments (GH-13116)
      9646630

    5. terryjreedy commented on May 6, 2019

      @terryjreedy
      Member

      Please do not close this until at least the idlelib changes are backported.

    6. matrixise commented on May 6, 2019

      @matrixise
      Member

      Hi Terry,

      Sure, thank you for the reminder.

    7. miss-islington commented on May 6, 2019

      @miss-islington
      Contributor

      New changeset b2d29bf by Miss Islington (bot) (penguindustin) in branch '3.7':
      [3.7] bpo-36766: Typos in docs and code comments (GH-13116). (GH-13136)
      b2d29bf

    8. terryjreedy commented on May 6, 2019

      @terryjreedy
      Member

      Dustin, thank you for both patches. Some people are not annoyed by minor typos. I am one who is. I hope you are enjoying and learning from the sprint.

    9. 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

    3.7 (EOL)end of life3.8 (EOL)end of lifedocsDocumentation 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