Document the rule that Python.h must be included before any standard

freddrake · freddrake · commit 396ca574ddf6 · 2001-09-06T16:30:30.000Z
headers.  This is the final checkin for SF bug #458768.
diff --git a/Doc/api/api.tex b/Doc/api/api.tex
@@ -76,6 +76,9 @@ \section{Include Files \label{includes}}
 This implies inclusion of the following standard headers:
 \code{<stdio.h>}, \code{<string.h>}, \code{<errno.h>},
 \code{<limits.h>}, and \code{<stdlib.h>} (if available).
+Since Python may define some pre-processor definitions which affect
+the standard headers on some systems, you must include \file{Python.h}
+before any standard headers are included.
 
 All user visible names defined by Python.h (except those defined by
 the included standard headers) have one of the prefixes \samp{Py} or
diff --git a/Doc/ext/extending.tex b/Doc/ext/extending.tex
@@ -46,8 +46,11 @@ \section{A Simple Example
 
 which pulls in the Python API (you can add a comment describing the
 purpose of the module and a copyright notice if you like).
+Since Python may define some pre-processor definitions which affect
+the standard headers on some systems, you must include \file{Python.h}
+before any standard headers are included.
 
-All user-visible symbols defined by \code{"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.
 For convenience, and since they are used extensively by the Python
 interpreter, \code{"Python.h"} includes a few standard header files:
@@ -951,7 +954,6 @@ \section{Keyword Parameters for Extension Functions
 \index{Philbrick, Geoff}
 
 \begin{verbatim}
-#include <stdio.h>
 #include "Python.h"
 
 static PyObject *
