Emphasize the requirement that Python.h be included first more strongly.

Closes SF bug #837228; backporting for Python 2.3.4.
This commit is contained in:
Fred Drake 2004-03-31 07:45:46 +00:00
parent 203b10c75a
commit 34c43202eb
2 changed files with 12 additions and 6 deletions

View file

@ -37,9 +37,12 @@ API are included in your code by the following line:
This implies inclusion of the following standard headers: This implies inclusion of the following standard headers:
\code{<stdio.h>}, \code{<string.h>}, \code{<errno.h>}, \code{<stdio.h>}, \code{<string.h>}, \code{<errno.h>},
\code{<limits.h>}, and \code{<stdlib.h>} (if available). \code{<limits.h>}, and \code{<stdlib.h>} (if available).
\begin{notice}[warning]
Since Python may define some pre-processor definitions which affect Since Python may define some pre-processor definitions which affect
the standard headers on some systems, you must include \file{Python.h} the standard headers on some systems, you \emph{must} include
before any standard headers are included. \file{Python.h} before any standard headers are included.
\end{notice}
All user visible names defined by Python.h (except those defined by All user visible names defined by Python.h (except those defined by
the included standard headers) have one of the prefixes \samp{Py} or the included standard headers) have one of the prefixes \samp{Py} or

View file

@ -46,9 +46,12 @@ The first line of our file can be:
which pulls in the Python API (you can add a comment describing the which pulls in the Python API (you can add a comment describing the
purpose of the module and a copyright notice if you like). purpose of the module and a copyright notice if you like).
\begin{notice}[warning]
Since Python may define some pre-processor definitions which affect Since Python may define some pre-processor definitions which affect
the standard headers on some systems, you must include \file{Python.h} the standard headers on some systems, you \emph{must} include
before any standard headers are included. \file{Python.h} before any standard headers are included.
\end{notice}
All user-visible symbols defined by \file{Python.h} have a prefix of All user-visible symbols defined by \file{Python.h} have a prefix of
\samp{Py} or \samp{PY}, except those defined in standard header files. \samp{Py} or \samp{PY}, except those defined in standard header files.