Commit graph

449 commits

Author SHA1 Message Date
Raymond Hettinger
a912c6c891 Fix and/add typo 2006-11-23 21:06:03 +00:00
Georg Brandl
393ac22b73 Patch #1592072: fix docs for return value of PyErr_CheckSignals. 2006-11-08 07:45:59 +00:00
Andrew M. Kuchling
acde6102c4 [Bug #1579796] Wrong syntax for PyDateTime_IMPORT in documentation. Reported by David Faure. 2006-10-26 19:10:46 +00:00
Georg Brandl
44a7b3a765 Bug #1546052: clarify that PyString_FromString(AndSize) copies the
string pointed to by its parameter.
2006-09-30 12:02:57 +00:00
Andrew M. Kuchling
c458433850 Minor edits 2006-08-18 13:57:13 +00:00
Georg Brandl
e7c9bad93d Typo in tp_clear docs. 2006-08-18 07:35:47 +00:00
Georg Brandl
648c110671 Bug #1541682: Fix example in the "Refcount details" API docs.
Additionally, remove a faulty example showing PySequence_SetItem applied
to a newly created list object and add notes that this isn't a good idea.
2006-08-18 07:27:59 +00:00
Georg Brandl
4873fb2bac Improve markup in PyUnicode_RichCompare. 2006-08-14 12:36:06 +00:00
Marc-André Lemburg
040f76b79c Slightly revised version of patch #1538956:
Replace UnicodeDecodeErrors raised during == and !=
compares of Unicode and other objects with a new
UnicodeWarning.

All other comparisons continue to raise exceptions.
Exceptions other than UnicodeDecodeErrors are also left
untouched.
2006-08-14 10:55:19 +00:00
Neal Norwitz
8a87f5d37e Patch #1538606, Patch to fix __index__() clipping.
I modified this patch some by fixing style, some error checking, and adding
XXX comments.  This patch requires review and some changes are to be expected.
I'm checking in now to get the greatest possible review and establish a
baseline for moving forward.  I don't want this to hold up release if possible.
2006-08-12 17:03:09 +00:00
Tim Peters
4643c2fda1 Followup to bug #1069160.
PyThreadState_SetAsyncExc():  internal correctness changes wrt
refcount safety and deadlock avoidance.  Also added a basic test
case (relying on ctypes) and repaired the docs.
2006-08-10 22:45:34 +00:00
Georg Brandl
7572f0322a `str is now the same object as types.StringType`. 2006-08-08 20:48:10 +00:00
Georg Brandl
6c223fe796 Bug #1536828: typo: TypeType should have been StringType. 2006-08-08 20:11:22 +00:00
Georg Brandl
fbf969928f Fix function name. 2006-07-31 16:00:34 +00:00
Andrew M. Kuchling
555ac45b20 Document PyErr_WarnEx. (Bad Neal! No biscuit!)
Is the explanation of the 'stacklevel' parameter clear?  Please feel free
to edit it.

I don't have LaTeX installed on this machine, so haven't verified that the
markup is correct.  Will check tonight, or maybe the automatic doc build will
tell me.
2006-07-31 12:39:05 +00:00
Andrew M. Kuchling
43bae4144b Add refcounts for PyErr_WarnEx 2006-07-31 12:20:24 +00:00
Fred Drake
e0d4aecfc2 lots of markup nits, most commonly Unix/unix --> \UNIX 2006-07-30 03:03:43 +00:00
Andrew M. Kuchling
a40191c305 [Patch #1490989 from Skip Montanaro] Mention debugging builds in the API documentation. I've changed Skip's patch to point to Misc/SpecialBuilds and fiddled with the markup a bit. 2006-07-29 19:24:04 +00:00
Thomas Heller
653f23cc81 Document the correct return type of PyLong_AsUnsignedLongLongMask. 2006-07-06 15:06:05 +00:00
Georg Brandl
69f6168b76 Bug #805015: doc error in PyUnicode_FromEncodedObject. 2006-06-14 16:46:43 +00:00
Martin v. Löwis
d825143be1 Patch #1455898: Incremental mode for "mbcs" codec. 2006-06-14 05:21:04 +00:00
Brett Cannon
ec0d6f83cd Clarify documentation for bf_getcharbuffer. 2006-06-07 21:48:17 +00:00
Martin v. Löwis
d004fc810a Patch 1494554: Update numeric properties to Unicode 4.1. 2006-05-27 08:36:52 +00:00
Georg Brandl
e001816dff Exception isn't the root of all exception classes anymore. 2006-05-26 19:04:47 +00:00
Georg Brandl
485dbd105f Add a x-ref to newer calling APIs. 2006-05-25 21:11:56 +00:00
Georg Brandl
9d67d5e9f7 Someone seems to just have copy-pasted the docs of
tp_compare to tp_richcompare ;)
2006-05-25 20:28:10 +00:00
Georg Brandl
658d513328 PyErr_NewException now accepts a tuple of base classes as its
"base" parameter.
2006-05-23 11:17:21 +00:00
Tim Peters
e6d9506611 Typo repair. 2006-05-13 23:31:05 +00:00
Tim Peters
8931ff1f67 Teach PyString_FromFormat, PyErr_Format, and PyString_FromFormatV
about "%u", "%lu" and "%zu" formats.

Since PyString_FromFormat and PyErr_Format have exactly the same rules
(both inherited from PyString_FromFormatV), it would be good if someone
with more LaTeX Fu changed one of them to just point to the other.
Their docs were way out of synch before this patch, and I just did a
mass copy+paste to repair that.

Not a backport candidate (this is a new feature).
2006-05-13 23:28:20 +00:00
Tim Peters
b06d28c160 SF patch #1473132: Improve docs for tp_clear and tp_traverse,
by Collin Winter.

Bugfix candidate (but I'm not going to bother).
2006-05-12 01:57:59 +00:00
Fred Drake
f25fa6ddb9 avoid ugly markup based on the unfortunate conversions of ">>" and "<<" to
guillemets; no need for magic here
2006-05-03 02:04:40 +00:00
Armin Rigo
a71fd71c3e Documentation bug: PySet_Pop() returns a new reference (because the
caller becomes the owner of that reference).
2006-05-02 19:52:32 +00:00
George Yoshida
9dea97a224 fix markup glitch 2006-04-28 16:09:45 +00:00
Martin v. Löwis
82972e7f01 Patch #702933: Undocument PyObject_NEW, PyObject_NEW_VAR,
and PyObject_DEL.
2006-04-14 15:58:03 +00:00
Martin v. Löwis
bb30011880 Stop claiming that Py_Finalize releases all memory.
Fixes part of #1445210.
2006-04-13 07:28:29 +00:00
Martin v. Löwis
0bc2ab9a20 Patch #837242: id() for large ptr should return a long. 2006-04-10 20:28:17 +00:00
Georg Brandl
4dce8e4e69 Bug #1464658: make clear that PyList_GetItem doesn't take negative indices. 2006-04-06 12:45:51 +00:00
Walter Dörwald
c44e14eba0 Fix typos. 2006-03-31 11:03:57 +00:00
Barry Warsaw
176014ffad SF patch #1458476 with modifications based on discussions in python-dev. This
adds the following API calls: PySet_Clear(), _PySet_Next(), and
_PySet_Update().  The latter two are considered non-public.  Tests and
documentation (for the public API) are included.
2006-03-30 22:45:35 +00:00
Fred Drake
66bc4efef3 fill in refcount information for APIs first documented in Python 2.5 2006-03-30 03:04:41 +00:00
Fred Drake
3e482d9a95 merge revision 43437 from the release24-maint branch:
- update the refcount information (late, but not a bad thing to do...)
- clarify that PyGen_New() steals a reference
2006-03-30 02:58:38 +00:00
Georg Brandl
b6e92c40a9 Document change made to number of preallocated integers. 2006-03-27 22:09:16 +00:00
Raymond Hettinger
66760f87b5 Show an example of calling a named set method. 2006-03-20 18:35:55 +00:00
Neal Norwitz
025f14b72d Move version added tag from PyObject_Length/Size to PyNumber_Index. 2006-03-08 05:29:18 +00:00
Guido van Rossum
38fff8c4e4 Checking in the code for PEP 357.
This was mostly written by Travis Oliphant.
I've inspected it all; Neal Norwitz and MvL have also looked at it
(in an earlier incarnation).
2006-03-07 18:50:55 +00:00
Brett Cannon
54ac29497e Document PEP 352 changes. Also added GeneratorExit. 2006-03-01 22:10:49 +00:00
Martin v. Löwis
c9066cafba Fix warning that texcheck complained about. 2006-03-01 16:37:55 +00:00
Fredrik Lundh
1f2dac5766 markup glitch (spotted by George Yoshida) 2006-03-01 12:43:53 +00:00
Martin v. Löwis
3b19754079 Document new Py_ssize_t API. 2006-03-01 05:47:11 +00:00
Martin v. Löwis
29fafd8708 Make documentation match the implementation. 2006-03-01 05:16:03 +00:00