[Python-checkins] python/dist/src/Doc/api concrete.tex,1.65,1.66
birkenfeld@users.sourceforge.net
birkenfeld at users.sourceforge.net
Sat Sep 3 09:27:37 CEST 2005
Update of /cvsroot/python/python/dist/src/Doc/api
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv2874/Doc/api
Modified Files:
concrete.tex
Log Message:
- Correct PyBool_FromLong's return type and its description.
- Unify function description mode ("Return X" vs "Returns X")
Index: concrete.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/api/concrete.tex,v
retrieving revision 1.65
retrieving revision 1.66
diff -u -d -r1.65 -r1.66
--- concrete.tex 17 Aug 2005 12:23:45 -0000 1.65
+++ concrete.tex 3 Sep 2005 07:27:26 -0000 1.66
@@ -36,20 +36,20 @@
\end{cvardesc}
\begin{cfuncdesc}{int}{PyType_Check}{PyObject *o}
- Returns true if the object \var{o} is a type object, including
- instances of types derived from the standard type object. Returns
+ Return true if the object \var{o} is a type object, including
+ instances of types derived from the standard type object. Return
false in all other cases.
\end{cfuncdesc}
\begin{cfuncdesc}{int}{PyType_CheckExact}{PyObject *o}
[...1472 lines suppressed...]
+ for missing keys. Raise a \exception{TypeError} if the \var{key} is
unhashable. Unlike the Python \method{discard()} method, this function
does not automatically convert unhashable sets into temporary frozensets.
- Raises \exception{PyExc_SystemError} if \var{set} is an not an instance
+ Raise \exception{PyExc_SystemError} if \var{set} is an not an instance
of \class{set} or its subtype.
\end{cfuncdesc}
\begin{cfuncdesc}{PyObject*}{PySet_Pop}{PyObject *set}
- Returns a new reference to an arbitrary object in the \var{set},
- and removes the object from the \var{set}. Returns \NULL{} on
- failure. Raises \exception{KeyError} if the set is empty.
- Raises a \exception{SystemError} if \var{set} is an not an instance
+ Return a new reference to an arbitrary object in the \var{set},
+ and removes the object from the \var{set}. Return \NULL{} on
+ failure. Raise \exception{KeyError} if the set is empty.
+ Raise a \exception{SystemError} if \var{set} is an not an instance
of \class{set} or its subtype.
\end{cfuncdesc}
More information about the Python-checkins
mailing list