python / python/cpython

A few typos, grammar mistakes, and code snippet errors in the docs

Open
#156,233 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs easy
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Documentation

(UPDATE: Added multiple suspected errors in code snippets in the documentation and another typo to this initial report in https://github.com/python/cpython/issues/156233#issuecomment-5435277380 as I was OK'd to open a PR but encouraged to expand the scope before sending a fix.)

Hello Python team,

this is just a typo so I know an issue is not required, but I hope you won't mind if I open one in case someone else wants to include it in a larger typo cleanup PR they are already doing (if no one picks it up after some time and I don't find other typos, I can send a PR).

In the latest version of https://docs.python.org/3/howto/mro.html#python-2-3-mro (archived as is at https://web.archive.org/web/20260822145356/https://docs.python.org/3/howto/mro.html#python-2-3-mro )

  • In the sentence

    Then repeat the operation until all the class are removed or it is impossible to find good heads.

    it seems "all the class" should be "all the classes".

Thanks so much!

Linked PRs
  • gh-156320
  • gh-156475
  • gh-157177
  • gh-157221
  • gh-157222
  • gh-157223
  • gh-157386

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the documentation page at docs.python.org/3/howto/mro.html#python-2-3-mro and review the reported grammar correction. Then read the issue comment for the added typo and code-snippet errors; the work is complete when the documented errors are corrected, though the linked PRs indicate that fixes are already underway.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.