Skip to content

Fix typos in C API documentation#149588

Merged
encukou merged 1 commit into
python:mainfrom
lpyu001:main
May 11, 2026
Merged

Fix typos in C API documentation#149588
encukou merged 1 commit into
python:mainfrom
lpyu001:main

Conversation

@lpyu001
Copy link
Copy Markdown
Contributor

@lpyu001 lpyu001 commented May 9, 2026

This PR fixes three small typos in the C API documentation:

  • Doc/c-api/slots.rst:
    • "essentally" → "essentially" (line 10)
    • "stuctures" → "structures" (line 13)
  • Doc/c-api/synchronization.rst:
    • "anotation" → "annotation" (line 241, in a comment)

No behavioural change, no API change. Trivial documentation fixes only.

@lpyu001 lpyu001 requested a review from ZeroIntensity as a code owner May 9, 2026 02:39
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels May 9, 2026
@python-cla-bot
Copy link
Copy Markdown

python-cla-bot Bot commented May 9, 2026

All commit authors signed the Contributor License Agreement.

CLA signed

@read-the-docs-community
Copy link
Copy Markdown

read-the-docs-community Bot commented May 9, 2026

Documentation build overview

📚 cpython-previews | 🛠️ Build #32612727 | 📁 Comparing 229a07e against main (354ef33)

  🔍 Preview build  

1 file changed
± c-api/slots.html

void PyCriticalSection2_BeginMutex(PyCriticalSection2 *c, PyMutex *m1, PyMutex *m2);

.. (These need to be in a separate section without a Stable ABI anotation.)
.. (These need to be in a separate section without a Stable ABI annotation.)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Strictly speaking, this is not user-facing because it's an rST comment so if we really want to restrict our attention to visible typos, we can revert that change.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO it's fine, we're going to merge the other fixes anyway.

Copy link
Copy Markdown
Member

@picnixz picnixz May 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are no other fixes in synchronization.rst. I think we can revert that part so that we only fix typos in Doc/c-api/slots.rst.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am also surprised that thre are only typos in slots.rst and synchronization.rst and not elsewhre.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added these last week, and didn't run a spell checker on the final PR.

I wonder how much of the world's energy usage goes into constantly scanning docs for small typos :/

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your work on this

@encukou encukou merged commit 53c3dd9 into python:main May 11, 2026
46 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs May 11, 2026
@encukou encukou added the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label May 11, 2026
@miss-islington-app
Copy link
Copy Markdown

Thanks @lpyu001 for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.15.
🐍🍒⛏🤖

@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented May 11, 2026

GH-149662 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label May 11, 2026
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 issue skip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants