Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Docs: Small tweaks to c-api/intro#Include_Files (GH-14698)

This commit is contained in:
Kyle Stanley 2019-09-10 11:09:34 -04:00 committed by Benjamin Peterson
parent faff81c05f
commit b6dafe5139
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Doc/c-api/intro.rst
View File

@ -69,10 +69,12 @@ standard headers) have one of the prefixes ``Py`` or ``_Py``. Names beginning
with ``_Py`` are for internal use by the Python implementation and should not be with ``_Py`` are for internal use by the Python implementation and should not be
used by extension writers. Structure member names do not have a reserved prefix. used by extension writers. Structure member names do not have a reserved prefix.
**Important:** user code should never define names that begin with ``Py`` or .. note::
``_Py``. This confuses the reader, and jeopardizes the portability of the user
code to future Python versions, which may define additional names beginning with User code should never define names that begin with ``Py`` or ``_Py``. This
one of these prefixes. confuses the reader, and jeopardizes the portability of the user code to
future Python versions, which may define additional names beginning with one
of these prefixes.
The header files are typically installed with Python. On Unix, these are The header files are typically installed with Python. On Unix, these are
located in the directories :file:`{prefix}/include/pythonversion/` and located in the directories :file:`{prefix}/include/pythonversion/` and
@ -90,9 +92,9 @@ multi-platform builds since the platform independent headers under
:envvar:`prefix` include the platform specific headers from :envvar:`prefix` include the platform specific headers from
:envvar:`exec_prefix`. :envvar:`exec_prefix`.
C++ users should note that though the API is defined entirely using C, the C++ users should note that although the API is defined entirely using C, the
header files do properly declare the entry points to be ``extern "C"``, so there header files properly declare the entry points to be ``extern "C"``. As a result,
is no need to do anything special to use the API from C++. there is no need to do anything special to use the API from C++.
Useful macros Useful macros