Skip to content

Commit 78c3949

Browse files
Docs: Small tweaks to c-api/introGH-Include_Files (GH-14698)
(cherry picked from commit b6dafe5) Co-authored-by: Kyle Stanley <[email protected]>
1 parent 30a8fd7 commit 78c3949

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

Doc/c-api/intro.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,12 @@ standard headers) have one of the prefixes ``Py`` or ``_Py``. Names beginning
6969
with ``_Py`` are for internal use by the Python implementation and should not be
7070
used by extension writers. Structure member names do not have a reserved prefix.
7171

72-
**Important:** user code should never define names that begin with ``Py`` or
73-
``_Py``. This confuses the reader, and jeopardizes the portability of the user
74-
code to future Python versions, which may define additional names beginning with
75-
one of these prefixes.
72+
.. note::
73+
74+
User code should never define names that begin with ``Py`` or ``_Py``. This
75+
confuses the reader, and jeopardizes the portability of the user code to
76+
future Python versions, which may define additional names beginning with one
77+
of these prefixes.
7678

7779
The header files are typically installed with Python. On Unix, these are
7880
located in the directories :file:`{prefix}/include/pythonversion/` and
@@ -90,9 +92,9 @@ multi-platform builds since the platform independent headers under
9092
:envvar:`prefix` include the platform specific headers from
9193
:envvar:`exec_prefix`.
9294

93-
C++ users should note that though the API is defined entirely using C, the
94-
header files do properly declare the entry points to be ``extern "C"``, so there
95-
is no need to do anything special to use the API from C++.
95+
C++ users should note that although the API is defined entirely using C, the
96+
header files properly declare the entry points to be ``extern "C"``. As a result,
97+
there is no need to do anything special to use the API from C++.
9698

9799

98100
Useful macros

0 commit comments

Comments
 (0)