Commit Graph

215 Commits

Author SHA1 Message Date
Raymond Hettinger
eb2823f894 Fix API typo. Closes SF 606216 2002-09-08 04:42:16 +00:00
Neal Norwitz
6fa4aec300 Fix SF bug 587012, doc mentions inexistent builtin unistr 2002-07-28 13:56:20 +00:00
Fred Drake
84dacffe6f Corrected return type and value information for PyUnicode_Count() and
PyUnicode_Find().
This closes SF bug #566631.
2002-06-20 22:09:12 +00:00
Fred Drake
70e87422b8 Fix documentation for PyMarshal_WriteObjectToFile() and
PyMarshal_WriteObjectToFile().
This closes SF bug #533735.
2002-06-17 15:45:21 +00:00
Fred Drake
53c47ac96e Clean up descriptions of PyObject_RichCompare() and PyObject_RichCompareBool()
based on comments from David Abrahams.
Added refcount information for these functions.
2002-06-14 14:36:23 +00:00
Fred Drake
4ffb172498 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
Anthony Baxter
43eb1d3ad3 backport theller's patch:
Typo: whcar_t should be wchar_t.

Bugfix candidate? Don't know how this is handled in the docs.

Original patch(es):
python/dist/src/Doc/api/concrete.tex:1.15
2002-04-30 04:07:57 +00:00
Anthony Baxter
608ee5a828 backport tim_one's patch:
Repair widespread misuse of _PyString_Resize.  Since it's clear people
don't understand how this function works, also beefed up the docs.  The
most common usage error is of this form (often spread out across gotos):

	if (_PyString_Resize(&s, n) < 0) {
		Py_DECREF(s);
		s = NULL;
		goto outtahere;
	}

The error is that if _PyString_Resize runs out of memory, it automatically
decrefs the input string object s (which also deallocates it, since its
refcount must be 1 upon entry), and sets s to NULL.  So if the "if"
branch ever triggers, it's an error to call Py_DECREF(s):  s is already
NULL!  A correct way to write the above is the simpler (and intended)

	if (_PyString_Resize(&s, n) < 0)
		goto outtahere;

Bugfix candidate.

Original patch(es):
python/dist/src/Doc/api/concrete.tex:1.13
2002-04-30 03:24:12 +00:00
Fred Drake
7addee3ab4 Document PyType_CheckExact(), PyType_IS_GC().
Update description of PyType_Check().
2002-04-10 18:00:44 +00:00
Fred Drake
cd1ec596ea Correct the descriptions of the PyObject_As*Buffer() return values.
This closes SF bug #539081.
2002-04-04 04:11:48 +00:00
Fred Drake
409bb439ed Backport Skip's patch for SF bug #534495:
exceptions.tex 1.5

fix a typo in PyErr_Format table and add row for 'p' format char
closes bug 534495
2002-03-27 14:08:21 +00:00
Fred Drake
804fea92fd 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
8a944345ce Documentation for PyObject_GetIter(), contributed by Greg Chapman
(with only minor changes by Fred).
This closes SF bug #498607.
2002-03-11 19:01:58 +00:00
Fred Drake
2d677d29e2 Correct the refcount information for the PyWeakref_GetObject() function.
This closes SF bug #520087.
2002-02-20 05:08:02 +00:00
Fred Drake
7b52ef2d3c Close an improperly-closed verbatim environment.
This closes SF patch #496215.

Add a little more detail to the example that had not been closed.
2001-12-28 04:30:38 +00:00
Fred Drake
54e6294197 A number of small adjustments. 2001-12-11 19:40:16 +00:00
Tim Peters
f582b82fe9 SF bug #491415 PyDict_UpdateFromSeq2() unused
PyDict_UpdateFromSeq2():  removed it.
PyDict_MergeFromSeq2():  made it public and documented it.
PyDict_Merge() docs:  updated to reveal <wink> that the second
argument can be any mapping object.
2001-12-11 18:51:08 +00:00
Fred Drake
32a3587345 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
551ffae30c Clarify that the Python runtime may behave mysteriously when an exception
is not handled properly.
This closes SF bug #485153.
2001-12-03 17:56:09 +00:00
Fred Drake
3570551d6f Remove most references to __members__ and __methods__, leaving only one pair
of references that now state that these attributes have been removed,
directing the reader to the dir() function.
This closes SF bug #456420.
2001-12-03 17:32:27 +00:00
Fred Drake
f07125ee53 PyErr_Format() does not return a new reference; it always returns NULL.
This closes SF bug #488387.
2001-12-03 16:36:43 +00:00
Fred Drake
454af89712 Update the signature of PyFile_WriteString(). 2001-11-29 22:42:59 +00:00
Fred Drake
c37b65ee10 Clean up some markup cruft. A number of the macros that take no
parameters (like \UNIX) are commonly entered using an empty group to
separate the markup from a following inter-word space; this is not
needed when the next character is punctuation, or the markup is the
last thing in the enclosing group.  These cases were marked
inconsistently; the empty group is now *only* used when needed.
2001-11-28 07:26:15 +00:00
Fred Drake
cd8474e6a2 Add documentation for the PyCell* APIs. 2001-11-26 21:29:17 +00:00
Fred Drake
50ecc15d05 Add omitted word for clarity. 2001-11-17 06:39:18 +00:00