Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 53fb772

Browse files
freddrakefreddrake
committed
Added index enties for the Python built-in functions, where appropriate.
1 parent e058b4f commit 53fb772

2 files changed

Lines changed: 30 additions & 24 deletions

File tree

‎Doc/api.tex‎

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -918,8 +918,9 @@ \section{Importing Modules}
918918
\begin{cfuncdesc}{PyObject *}{PyImport_ImportModuleEx}{char *name, PyObject *globals, PyObject *locals, PyObject *fromlist}
919919
\strong{(NEW in 1.5a4!)}
920920
Import a module. This is best described by referring to the built-in
921-
Python function \function{__import__()}, as the standard
922-
\function{__import__()} function calls this function directly.
921+
Python function \function{__import__()}\bifuncindex{__import__}, as
922+
the standard \function{__import__()} function calls this function
923+
directly.
923924
924925
The return value is a new reference to the imported module or
925926
top-level package, or \NULL{} with an exception set on failure
@@ -939,7 +940,7 @@ \section{Importing Modules}
939940
940941
\begin{cfuncdesc}{PyObject *}{PyImport_ReloadModule}{PyObject *m}
941942
Reload a module. This is best described by referring to the built-in
942-
Python function \function{reload()}, as the standard
943+
Python function \function{reload()}\bifuncindex{reload}, as the standard
943944
\function{reload()} function calls this function directly. Return a
944945
new reference to the reloaded module, or \NULL{} with an exception set
945946
on failure (the module still exists in this case).
@@ -958,10 +959,11 @@ \section{Importing Modules}
958959
\begin{cfuncdesc}{PyObject *}{PyImport_ExecCodeModule}{char *name, PyObject *co}
959960
Given a module name (possibly of the form \code{package.module}) and a
960961
code object read from a Python bytecode file or obtained from the
961-
built-in function \function{compile()}, load the module. Return a new
962-
reference to the module object, or \NULL{} with an exception set
963-
if an error occurred (the module may still be created in this case).
964-
(This function would reload the module if it was already imported.)
962+
built-in function \function{compile()}\bifuncindex{compile}, load the
963+
module. Return a new reference to the module object, or \NULL{} with
964+
an exception set if an error occurred (the module may still be created
965+
in this case). (This function would reload the module if it was
966+
already imported.)
965967
\end{cfuncdesc}
966968
967969
\begin{cfuncdesc}{long}{PyImport_GetMagicNumber}{}
@@ -1200,6 +1202,7 @@ \section{Object Protocol}
12001202
On success, returns a type object corresponding to the object
12011203
type of object \var{o}. On failure, returns \NULL{}. This is
12021204
equivalent to the Python expression \samp{type(\var{o})}.
1205+
\bifuncindex{type}
12031206
\end{cfuncdesc}
12041207
12051208
\begin{cfuncdesc}{int}{PyObject_Length}{PyObject *o}
@@ -1277,15 +1280,15 @@ \section{Number Protocol}
12771280
12781281
12791282
\begin{cfuncdesc}{PyObject*}{PyNumber_Divmod}{PyObject *o1, PyObject *o2}
1280-
See the built-in function \function{divmod()}. Returns \NULL{} on
1281-
failure. This is the equivalent of the Python expression
1282-
\samp{divmod(\var{o1}, \var{o2})}.
1283+
See the built-in function \function{divmod()}\bifuncindex{divmod}.
1284+
Returns \NULL{} on failure. This is the equivalent of the Python
1285+
expression \samp{divmod(\var{o1}, \var{o2})}.
12831286
\end{cfuncdesc}
12841287
12851288
12861289
\begin{cfuncdesc}{PyObject*}{PyNumber_Power}{PyObject *o1, PyObject *o2, PyObject *o3}
1287-
See the built-in function \function{pow()}. Returns \NULL{} on
1288-
failure. This is the equivalent of the Python expression
1290+
See the built-in function \function{pow()}\bifuncindex{pow}. Returns
1291+
\NULL{} on failure. This is the equivalent of the Python expression
12891292
\samp{pow(\var{o1}, \var{o2}, \var{o3})}, where \var{o3} is optional.
12901293
If \var{o3} is to be ignored, pass \code{Py_None} in its place.
12911294
\end{cfuncdesc}

‎Doc/api/api.tex‎

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -918,8 +918,9 @@ \section{Importing Modules}
918918
\begin{cfuncdesc}{PyObject *}{PyImport_ImportModuleEx}{char *name, PyObject *globals, PyObject *locals, PyObject *fromlist}
919919
\strong{(NEW in 1.5a4!)}
920920
Import a module. This is best described by referring to the built-in
921-
Python function \function{__import__()}, as the standard
922-
\function{__import__()} function calls this function directly.
921+
Python function \function{__import__()}\bifuncindex{__import__}, as
922+
the standard \function{__import__()} function calls this function
923+
directly.
923924
924925
The return value is a new reference to the imported module or
925926
top-level package, or \NULL{} with an exception set on failure
@@ -939,7 +940,7 @@ \section{Importing Modules}
939940
940941
\begin{cfuncdesc}{PyObject *}{PyImport_ReloadModule}{PyObject *m}
941942
Reload a module. This is best described by referring to the built-in
942-
Python function \function{reload()}, as the standard
943+
Python function \function{reload()}\bifuncindex{reload}, as the standard
943944
\function{reload()} function calls this function directly. Return a
944945
new reference to the reloaded module, or \NULL{} with an exception set
945946
on failure (the module still exists in this case).
@@ -958,10 +959,11 @@ \section{Importing Modules}
958959
\begin{cfuncdesc}{PyObject *}{PyImport_ExecCodeModule}{char *name, PyObject *co}
959960
Given a module name (possibly of the form \code{package.module}) and a
960961
code object read from a Python bytecode file or obtained from the
961-
built-in function \function{compile()}, load the module. Return a new
962-
reference to the module object, or \NULL{} with an exception set
963-
if an error occurred (the module may still be created in this case).
964-
(This function would reload the module if it was already imported.)
962+
built-in function \function{compile()}\bifuncindex{compile}, load the
963+
module. Return a new reference to the module object, or \NULL{} with
964+
an exception set if an error occurred (the module may still be created
965+
in this case). (This function would reload the module if it was
966+
already imported.)
965967
\end{cfuncdesc}
966968
967969
\begin{cfuncdesc}{long}{PyImport_GetMagicNumber}{}
@@ -1200,6 +1202,7 @@ \section{Object Protocol}
12001202
On success, returns a type object corresponding to the object
12011203
type of object \var{o}. On failure, returns \NULL{}. This is
12021204
equivalent to the Python expression \samp{type(\var{o})}.
1205+
\bifuncindex{type}
12031206
\end{cfuncdesc}
12041207
12051208
\begin{cfuncdesc}{int}{PyObject_Length}{PyObject *o}
@@ -1277,15 +1280,15 @@ \section{Number Protocol}
12771280
12781281
12791282
\begin{cfuncdesc}{PyObject*}{PyNumber_Divmod}{PyObject *o1, PyObject *o2}
1280-
See the built-in function \function{divmod()}. Returns \NULL{} on
1281-
failure. This is the equivalent of the Python expression
1282-
\samp{divmod(\var{o1}, \var{o2})}.
1283+
See the built-in function \function{divmod()}\bifuncindex{divmod}.
1284+
Returns \NULL{} on failure. This is the equivalent of the Python
1285+
expression \samp{divmod(\var{o1}, \var{o2})}.
12831286
\end{cfuncdesc}
12841287
12851288
12861289
\begin{cfuncdesc}{PyObject*}{PyNumber_Power}{PyObject *o1, PyObject *o2, PyObject *o3}
1287-
See the built-in function \function{pow()}. Returns \NULL{} on
1288-
failure. This is the equivalent of the Python expression
1290+
See the built-in function \function{pow()}\bifuncindex{pow}. Returns
1291+
\NULL{} on failure. This is the equivalent of the Python expression
12891292
\samp{pow(\var{o1}, \var{o2}, \var{o3})}, where \var{o3} is optional.
12901293
If \var{o3} is to be ignored, pass \code{Py_None} in its place.
12911294
\end{cfuncdesc}

0 commit comments

Comments
 (0)