Mercurial > cpython-lru_cache-weakref
diff Doc/api/api.tex @ 18020:e86d33081bba legacy-trunk
Explained more differences between PyList_SetItem() and PyList_SET_ITEM().
In particular, the affect on existing list content was not sufficiently
explained.
This closes SF bug #429554.
| author | Fred Drake <fdrake@acm.org> |
|---|---|
| date | Sun, 03 Jun 2001 03:12:57 +0000 |
| parents | ec9343ad1e60 |
| children | 19bc63a84439 |
line wrap: on
line diff
--- a/Doc/api/api.tex Sat Jun 02 08:27:39 2001 +0000 +++ b/Doc/api/api.tex Sun Jun 03 03:12:57 2001 +0000 @@ -3304,13 +3304,18 @@ \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,
