[Python-checkins] Docs: Small tweaks to c-api/introGH-Include_Files (GH-14698)
Miss Islington (bot)
webhook-mailer at python.org
Tue Sep 10 12:38:11 EDT 2019
https://github.com/python/cpython/commit/78c3949407580593f92968ea268630c36ebe6634
commit: 78c3949407580593f92968ea268630c36ebe6634
branch: 3.8
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2019-09-10T09:38:07-07:00
summary:
Docs: Small tweaks to c-api/introGH-Include_Files (GH-14698)
(cherry picked from commit b6dafe51399f5c6313a00529118a6052b466942f)
Co-authored-by: Kyle Stanley <aeros167 at gmail.com>
files:
M Doc/c-api/intro.rst
diff --git a/Doc/c-api/intro.rst b/Doc/c-api/intro.rst
index a1c8d34a7ea0..80eebd89ad3f 100644
--- a/Doc/c-api/intro.rst
+++ b/Doc/c-api/intro.rst
@@ -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
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
-``_Py``. This 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.
+.. note::
+
+ User code should never define names that begin with ``Py`` or ``_Py``. This
+ 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
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:`exec_prefix`.
-C++ users should note that though the API is defined entirely using C, the
-header files do properly declare the entry points to be ``extern "C"``, so there
-is no need to do anything special to use the API from C++.
+C++ users should note that although the API is defined entirely using C, the
+header files properly declare the entry points to be ``extern "C"``. As a result,
+there is no need to do anything special to use the API from C++.
Useful macros
More information about the Python-checkins
mailing list