Skip to content

Fix typos in C API documentation#149588

Open
lpyu001 wants to merge 1 commit intopython:mainfrom
lpyu001:main
Open

Fix typos in C API documentation#149588
lpyu001 wants to merge 1 commit intopython:mainfrom
lpyu001:main

Conversation

@lpyu001
Copy link
Copy Markdown

@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 •
edited
Loading

All commit authors signed the Contributor License Agreement.

CLA signed

@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs May 9, 2026
@read-the-docs-community
Copy link
Copy Markdown

read-the-docs-community Bot commented May 9, 2026 •
edited
Loading

Documentation build overview

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

  🔍 Preview build  

1 file changed
± c-api/slots.html

@StanFromIreland StanFromIreland requested a review from encukou May 9, 2026 09:15
picnixz
picnixz reviewed May 9, 2026
View reviewed changes
Comment thread Doc/c-api/synchronization.rst
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

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

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

@StanFromIreland StanFromIreland May 9, 2026

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 •
edited
Loading

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

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

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

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

Reviewers

@picnixz picnixz picnixz left review comments

@StanFromIreland StanFromIreland StanFromIreland approved these changes

@skirpichev skirpichev skirpichev approved these changes

@ZeroIntensity ZeroIntensity Awaiting requested review from ZeroIntensity ZeroIntensity is a code owner

@encukou encukou Awaiting requested review from encukou

Assignees

No one assigned

Labels

awaiting merge docs Documentation in the Doc dir skip issue skip news

Projects

Docs PRs
Status: Todo

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@lpyu001 @skirpichev @picnixz @StanFromIreland