150 Commits

Author SHA1 Message Date
Fred Drake
8bb9fe89b8 Correct some return value information. 2002-08-27 18:41:26 +00:00
Fred Drake
4c8d12744e Add documentation for PyObject_RichCompare() and PyObject_RichCompareBool(),
constributed by David Abrahams.
This closes SF patch #568081.
2002-06-13 11:53:54 +00:00
Fred Drake
ba9c5659f0 Document PyType_IS_GC().
Update description of PyType_Check().
2002-04-10 18:16:32 +00:00
Fred Drake
5c7855afb9 Add the PyObject_As*Buffer() functions that apply, now that the docs have been
corrected and I'm dealing with them anyway.
2002-04-04 04:21:23 +00:00
Fred Drake
c9868fe65c Add a note that Py_None needs the same reference count treatment as any
other PyObject *.
This closes SF bug #494007.
2002-03-12 20:18:01 +00:00
Fred Drake
33f9fa7f8c Document that PyString_FromString() cannot take NULL as a parameter.
This closes SF bug #489872.
2001-12-06 20:38:15 +00:00
Fred Drake
35b9c24dce Fix the markup of the caret charater in a couple of places; LaTeX's
special character bite us again.  ;-(

This fixes SF bug #440911.
2001-07-14 03:07:55 +00:00
Fred Drake
d11f5f3eb5 Move the section on concrete numeric objects before the section on
concrete sequence objects, since their API is simpler.

This is in response to a comment in SF bug #440037.

(Does this really belong in the bugfix release?  Yes: this is a readability
bug, and those are important in the documentation.)
2001-07-11 20:40:05 +00:00
Fred Drake
93e543c7fc Corrected the refcount information for PyList_SET_ITEM(). 2001-07-10 16:19:26 +00:00
Fred Drake
919b65e1df Document PyObject_New(), PyObject_NewVar(), PyObject_Init(),
PyObject_InitVar(), PyObject_Del(), PyObject_NEW(),
PyObject_NEW_VAR(), and PyObject_DEL().

Add notes to PyMem_Malloc() and PyMem_New() about the memory buffers
not being initialized.

This fixes SF bug #439012.


Added explicit return value information for PyList_SetItem(),
PyDict_SetItem(), and PyDict_SetItemString().  Corrected return type
for PyList_SET_ITEM().

Fixed index entries in the descriptions of PyLong_AsLong() and
PyLong_AsUnignedLong().

This fixes the API manual portion of SF bug #440037.


Note that the headers properly declare everything as 'extern "C"' for
C++ users.

Document _Py_NoneStruct.

Added links to the Extending & Embedding manual for PyArg_ParseTuple()
and PyArg_ParseTupleAndKeywords().

Added note that PyArg_Parse() should not be used in new code.

Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
translation more difficult, as well as reading the English more
difficult for non-native speakers.
2001-07-10 16:11:09 +00:00
Thomas Wouters
42af3cedd9 Fix for SF bug #436525, reported by Greg Kochanski:
The block/unblock thread macros are called 'Py_BLOCK_THREADS' and
'Py_UNBLOCK_THREADS', not 'Py_BEGIN_BLOCK_THREADS' and
'Py_BEGIN_UNBLOCK_THREADS'.
2001-07-09 14:34:16 +00:00
Fred Drake
495739f8b2 Added documentation for PyErr_SetFromErrnoWithFilename(). 2001-06-21 18:56:49 +00:00
Fred Drake
257f7d0706 Adjust the documents so that the copyright is at the front of the documents
and the license statements are at the end.  This is less annoying to readers.
2001-06-21 18:52:50 +00:00
Fred Drake
9d26f81b90 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.
2001-06-03 03:16:04 +00:00
Fred Drake
ecf1b65e90 Users of PySequence_GET_FAST() should get the length of the sequence using
PySequence_Size(), not PyObject_Size(): the later considers the mapping
methods as well as the sequence methods, which is not needed here.  Either
should be equally fast in this case, but PySequence_Size() offers a better
conceptual match.
2001-05-29 18:53:11 +00:00
Fred Drake
634f45ad4d Add documentation for Py_Main() and PyThreadState_GetDict(). 2001-05-21 15:58:54 +00:00
Fred Drake
cd2f28d357 Typo: "that" --> "than"
This closes SF bug #425320.
2001-05-21 15:04:28 +00:00
Fred Drake
8d00a0ffc3 Michael Hudson:
Update docs for PyDict_Next() based on the most recent changes to the
dictionary code.

This closes SF patch #409864.
2001-04-13 17:55:02 +00:00
Fred Drake
d20d8b319c Work around the conversion of ">>" and "<<" to guillemets. Reported by Ping. 2001-04-13 14:52:39 +00:00
Greg Stein
4d4d0034c0 Correct the documentation for getreadbufferproc and getwritebufferproc.
Fixes bug #233308 from Travis Oliphant.
2001-04-07 16:14:49 +00:00
Fred Drake
c6a3cb4baf Document PySequence_Size(), and describe PySequence_Length() as simply an
alternate name for the same function.
2001-04-04 01:25:17 +00:00
Fred Drake
58c8f9f631 Added documentation for PyObject_IsInstance() and PyObject_IsSubclass(). 2001-03-28 21:14:32 +00:00
Fred Drake
8f6df46d40 Strengthen the constraints on calling PyObject_GC_Fini(). 2001-03-23 17:42:09 +00:00
Fred Drake
e28d8aef2d Be more clear about the specific rules for supporting the cyclic GC in an
extension object.  Also included an example showing exactly what needs to
be done and nothing else.

This closes SF bug #228591.
2001-03-22 16:30:17 +00:00
Fred Drake
c392b570db Integrated an expanded version of some text from Neil Schemenauer about
supporting cyclic garbage collection.  (This is not all of it, but I'm
taking a break!)

Also fixed some markup nits.
2001-03-21 22:15:01 +00:00