From: Victor Stinner <victor.stinner@haypocalc.com>
Date: Mon, 7 Mar 2011 17:34:59 +0000 (+0100)
Subject: Issue #3080: Document the name attribute of the _inittab structure
X-Git-Tag: v3.3.0a1~2873
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=db536afee14ebd2b74488313e1b1db5cd17fefdc;p=thirdparty%2FPython%2Fcpython.git

Issue #3080: Document the name attribute of the _inittab structure

The name is an ASCII encoded string.
---

diff --git a/Doc/c-api/import.rst b/Doc/c-api/import.rst
index c9556b61aa0c..885a752fea0a 100644
--- a/Doc/c-api/import.rst
+++ b/Doc/c-api/import.rst
@@ -272,13 +272,13 @@ Importing Modules
 
    Structure describing a single entry in the list of built-in modules.  Each of
    these structures gives the name and initialization function for a module built
-   into the interpreter.  Programs which embed Python may use an array of these
-   structures in conjunction with :c:func:`PyImport_ExtendInittab` to provide
-   additional built-in modules.  The structure is defined in
-   :file:`Include/import.h` as::
+   into the interpreter.  The name is an ASCII encoded string.  Programs which
+   embed Python may use an array of these structures in conjunction with
+   :c:func:`PyImport_ExtendInittab` to provide additional built-in modules.
+   The structure is defined in :file:`Include/import.h` as::
 
       struct _inittab {
-          char *name;
+          char *name;                 /* ASCII encoded string */
           PyObject* (*initfunc)(void);
       };
 
diff --git a/Include/import.h b/Include/import.h
index 710fd22914d0..6a62c94c6860 100644
--- a/Include/import.h
+++ b/Include/import.h
@@ -87,7 +87,7 @@ PyAPI_FUNC(int)_PyImport_FixupBuiltin(
 PyAPI_FUNC(int)_PyImport_FixupExtensionObject(PyObject*, PyObject *, PyObject *);
 
 struct _inittab {
-    char *name;
+    char *name;                 /* ASCII encoded string */
     PyObject* (*initfunc)(void);
 };
 PyAPI_DATA(struct _inittab *) PyImport_Inittab;