Skip to content

Fix typos in C API documentation #149588

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lpyu001 wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −3
Open

Fix typos in C API documentation #149588

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Doc/c-api/slots.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Definition slots

To define :ref:`module objects <moduleobjects>` and
:ref:`classes <creating-heap-types>` using the C API, you may use
an array of *slots* -- essentally, key-value pairs that describe features
an array of *slots* -- essentially, key-value pairs that describe features
of the object to create.
This decouples the data from the structures used at runtime, allowing CPython
-- and other Python C API implementations -- to update the stuctures without
-- and other Python C API implementations -- to update the structures without
breaking backwards compatibility.

This section documents slots in general.
Expand Down
2 changes: 1 addition & 1 deletion Doc/c-api/synchronization.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ are not available.
.. c:function:: void PyCriticalSection_BeginMutex(PyCriticalSection *c, PyMutex *m);
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.


To be used only as in the macro expansions
listed :ref:`earlier in this section <critical-section-macros>`.
Expand Down
Loading