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

Skip to content

Commit 891150b

Browse files
committed
Added documentation for the new PyModule_*() convenience functions.
This closes SourceForge patch #101233.
1 parent 9e28515 commit 891150b

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

Doc/api/api.tex

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3680,6 +3680,32 @@ \subsection{Module Objects \label{moduleObjects}}
36803680
\withsubitem{(built-in exception)}{\ttindex{SystemError}}
36813681
\end{cfuncdesc}
36823682

3683+
\begin{cfuncdesc}{int}{PyModule_AddObject}{PyObject *module,
3684+
char *name, PyObject *value}
3685+
Add an object to \var{module} as \var{name}. This is a convenience
3686+
function which can be used from the module's initialization function.
3687+
This steals a reference to \var{value}. Returns \code{-1} on error,
3688+
\code{0} on success.
3689+
\versionadded{2.0}
3690+
\end{cfuncdesc}
3691+
3692+
\begin{cfuncdesc}{int}{PyModule_AddIntConstant}{PyObject *module,
3693+
char *name, int value}
3694+
Add an integer constant to \var{module} as \var{name}. This convenience
3695+
function can be used from the module's initialization function.
3696+
Returns \code{-1} on error, \code{0} on success.
3697+
\versionadded{2.0}
3698+
\end{cfuncdesc}
3699+
3700+
\begin{cfuncdesc}{int}{PyModule_AddStringConstant}{PyObject *module,
3701+
char *name, char *value}
3702+
Add a string constant to \var{module} as \var{name}. This convenience
3703+
function can be used from the module's initialization function. The
3704+
string \var{value} must be null-terminated. Returns \code{-1} on
3705+
error, \code{0} on success.
3706+
\versionadded{2.0}
3707+
\end{cfuncdesc}
3708+
36833709

36843710
\subsection{CObjects \label{cObjects}}
36853711

0 commit comments

Comments
 (0)