Skip to content

gh-156233: Fix grammar in MRO documentation - #156320

Closed
aryansk wants to merge 1 commit into
python:mainfrom
aryansk:fix-mro-grammar-156233
Closed

gh-156233: Fix grammar in MRO documentation#156320
aryansk wants to merge 1 commit into
python:mainfrom
aryansk:fix-mro-grammar-156233

Conversation

@aryansk

@aryansk aryansk commented Aug 24, 2026

Copy link
Copy Markdown

Fixes #156233

Problem

Doc/howto/mro.rst contains a grammar typo:

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

Singular "class" disagrees with plural verb "are". The sentence describes removing multiple classes during MRO merge, so plural "classes" is correct.

Issue: #156233
Source: Doc/howto/mro.rst:192 (Doc/howto/mro.html#python-2-3-mro)

Change

  • Fix Doc/howto/mro.rst:192 from all the class are removedall the classes are removed
  • Keep unrelated cleanup out of this PR

Why this approach

Minimal one-line docs fix matching the issue's suggested correction. No code or behavior change.

Testing

command: git diff --check
result: clean

command: grep -n "all the class" Doc/howto/mro.rst
result: no matches (fixed)

command: grep -n "all the classes are removed" Doc/howto/mro.rst
result: 192:  the operation until all the classes are removed or it is impossible to

Doc build: Doc/howto/mro.rst renders as before with corrected grammar; no functional tests required for docs-only change.

Documentation and release impact

  • User-facing documentation updated
  • Changelog/release note needed: docs fix, no NEWS blurb required per CPython docs-only convention (trivial typo)
  • Migration or compatibility note needed
  • No documentation impact

Review notes

  • Known limitations: none
  • Follow-up issue, if any: none
  • Security/licensing considerations: none

Fixes python#156233

The sentence "Then repeat the operation until all the class are
removed..." incorrectly uses singular "class".
Change to "all the classes are removed" to match plural subject.

Validation: git diff --check clean; verified rendering of
Doc/howto/mro.rst via local inspection.
@bedevere-app bedevere-app Bot added the docs Documentation in the Doc dir label Aug 24, 2026
@python-cla-bot

python-cla-bot Bot commented Aug 24, 2026

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

CLA signed

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #34207577 | 📁 Comparing 6b7f5b3 against main (ee1da7e)

  🔍 Preview build  

1 file changed
± howto/mro.html

@willy-b

willy-b commented Aug 27, 2026

Copy link
Copy Markdown

Thanks very much for sharing this.

However, I think this is now redundant with #156475 (I had already agreed to fix this issue I discovered/reported before you opened this PR) which also fixes another typo and a couple of code snippet errors, so you can probably go ahead and close this PR.

If you would like me, going forward, to provide you suspected typos and other documentation errors to send PRs for and follow to resolution, let me know and I can divvy up what I find in the future and offer to assign some to you.

@StanFromIreland

Copy link
Copy Markdown
Member

Closing in favour of #156475

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

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

3 participants