[Python-checkins] cpython: Issue #3080: Document the name attribute of the _inittab structure

[victor.stinner]

http://hg.python.org/cpython/rev/e63a583ec689
changeset:   68714:e63a583ec689
user:        Victor Stinner <victor.stinner at haypocalc.com>
date:        Mon Mar 07 18:34:59 2011 +0100
summary:
  Issue #3080: Document the name attribute of the _inittab structure

The name is an ASCII encoded string.

files:
  Doc/c-api/import.rst
  Include/import.h

diff --git a/Doc/c-api/import.rst b/Doc/c-api/import.rst
--- a/Doc/c-api/import.rst
+++ b/Doc/c-api/import.rst
@@ -272,13 +272,13 @@
 
    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
--- a/Include/import.h
+++ b/Include/import.h
@@ -87,7 +87,7 @@
 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;

-- 
Repository URL: http://hg.python.org/cpython