Commit 2619c9ec authored by Raymond Hettinger's avatar Raymond Hettinger

SF patch #838938: Typos in the docs (Extending/Embedding + Python/C API)

(Contributed by Florent Rougon.)
parent e3d5f981
...@@ -267,7 +267,7 @@ determination. ...@@ -267,7 +267,7 @@ determination.
\begin{cfuncdesc}{PyObject*}{PyObject_CallMethod}{PyObject *o, \begin{cfuncdesc}{PyObject*}{PyObject_CallMethod}{PyObject *o,
char *method, char *format, char *method, char *format,
\moreargs} \moreargs}
Call the method named \var{m} of object \var{o} with a variable Call the method named \var{method} of object \var{o} with a variable
number of C arguments. The C arguments are described by a number of C arguments. The C arguments are described by a
\cfunction{Py_BuildValue()} format string. The format may be \NULL, \cfunction{Py_BuildValue()} format string. The format may be \NULL,
indicating that no arguments are provided. Returns the result of the indicating that no arguments are provided. Returns the result of the
......
...@@ -331,9 +331,8 @@ for each thread. ...@@ -331,9 +331,8 @@ for each thread.
example, when an exception occurs in an \method{__del__()} method. example, when an exception occurs in an \method{__del__()} method.
The function is called with a single argument \var{obj} that The function is called with a single argument \var{obj} that
identifies where the context in which the unraisable exception identifies the context in which the unraisable exception occurred.
occurred. The repr of \var{obj} will be printed in the warning The repr of \var{obj} will be printed in the warning message.
message.
\end{cfuncdesc} \end{cfuncdesc}
\section{Standard Exceptions \label{standardExceptions}} \section{Standard Exceptions \label{standardExceptions}}
......
...@@ -166,7 +166,7 @@ These macros are used in the definition of \ctype{PyObject} and ...@@ -166,7 +166,7 @@ These macros are used in the definition of \ctype{PyObject} and
This is a macro which expands to the declarations of the fields of This is a macro which expands to the declarations of the fields of
the \ctype{PyObject} type; it is used when declaring new types which the \ctype{PyObject} type; it is used when declaring new types which
represent objects without a varying length. The specific fields it represent objects without a varying length. The specific fields it
expands to depends on the definition of expands to depend on the definition of
\csimplemacro{Py_TRACE_REFS}. By default, that macro is not \csimplemacro{Py_TRACE_REFS}. By default, that macro is not
defined, and \csimplemacro{PyObject_HEAD} expands to: defined, and \csimplemacro{PyObject_HEAD} expands to:
\begin{verbatim} \begin{verbatim}
...@@ -397,7 +397,7 @@ Foo_Type.ob_type = &PyType_Type; ...@@ -397,7 +397,7 @@ Foo_Type.ob_type = &PyType_Type;
This should be done before any instances of the type are created. This should be done before any instances of the type are created.
\cfunction{PyType_Ready()} checks if \member{ob_type} is \NULL, and \cfunction{PyType_Ready()} checks if \member{ob_type} is \NULL, and
if so, initializes it: in Python 2.2, it is set to if so, initializes it: in Python 2.2, it is set to
\code{\&PyType_Type}; in Python 2.2.1 and later it will be \code{\&PyType_Type}; in Python 2.2.1 and later it is
initialized to the \member{ob_type} field of the base class. initialized to the \member{ob_type} field of the base class.
\cfunction{PyType_Ready()} will not change this field if it is \cfunction{PyType_Ready()} will not change this field if it is
non-zero. non-zero.
...@@ -704,7 +704,7 @@ PyMappingMethods *tp_as_mapping; ...@@ -704,7 +704,7 @@ PyMappingMethods *tp_as_mapping;
\end{cmemberdesc} \end{cmemberdesc}
\begin{cmemberdesc}{PyTypeObject}{PyBufferProcs*}{tp_as_buffer} \begin{cmemberdesc}{PyTypeObject}{PyBufferProcs*}{tp_as_buffer}
Pointer to an additional structure contains fields relevant only to Pointer to an additional structure that contains fields relevant only to
objects which implement the buffer interface. These fields are objects which implement the buffer interface. These fields are
documented in ``Buffer Object Structures'' (section documented in ``Buffer Object Structures'' (section
\ref{buffer-structs}). \ref{buffer-structs}).
......
...@@ -537,7 +537,7 @@ and assign them to the \member{tp_methods} slot: ...@@ -537,7 +537,7 @@ and assign them to the \member{tp_methods} slot:
Noddy_methods, /* tp_methods */ Noddy_methods, /* tp_methods */
\end{verbatim} \end{verbatim}
Note that used the \constant{METH_NOARGS} flag to indicate that the Note that we used the \constant{METH_NOARGS} flag to indicate that the
method is passed no arguments. method is passed no arguments.
Finally, we'll make our type usable as a base class. We've written Finally, we'll make our type usable as a base class. We've written
...@@ -683,7 +683,7 @@ when objects are involved in cycles. For example, consider: ...@@ -683,7 +683,7 @@ when objects are involved in cycles. For example, consider:
\end{verbatim} \end{verbatim}
In this example, we create a list that contains itself. When we delete In this example, we create a list that contains itself. When we delete
it, it still has a reference from itself. It's reference count doesn't it, it still has a reference from itself. Its reference count doesn't
drop to zero. Fortunately, Python's cyclic-garbage collector will drop to zero. Fortunately, Python's cyclic-garbage collector will
eventually figure out that the list is garbage and free it. eventually figure out that the list is garbage and free it.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment