diff options
| -rw-r--r-- | Doc/api/api.tex | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/Doc/api/api.tex b/Doc/api/api.tex index 613f62c..a4886a7 100644 --- a/Doc/api/api.tex +++ b/Doc/api/api.tex @@ -3304,13 +3304,18 @@ Macro form of \cfunction{PyList_GetItem()} without error checking. \begin{cfuncdesc}{int}{PyList_SetItem}{PyObject *list, int index, PyObject *item} Sets the item at index \var{index} in list to \var{item}. -\strong{Note:} This function ``steals'' a reference to \var{item}. +\strong{Note:} This function ``steals'' a reference to \var{item} and +discards a reference to an item already in the list at the affected +position. \end{cfuncdesc} \begin{cfuncdesc}{PyObject*}{PyList_SET_ITEM}{PyObject *list, int i, PyObject *o} Macro form of \cfunction{PyList_SetItem()} without error checking. -\strong{Note:} This function ``steals'' a reference to \var{item}. +\strong{Note:} This function ``steals'' a reference to \var{item}, +and, unlike \cfunction{PyList_SetItem()}, does \emph{not} discard a +reference to any item that it being replaced. This is normally only +used to fill in new lists where there is no previous content.. \end{cfuncdesc} \begin{cfuncdesc}{int}{PyList_Insert}{PyObject *list, int index, |