Commit Graph

815 Commits

Author SHA1 Message Date
Martin Panter b398d2c2bf Issue #28771: Correct documentation of signatures using const 2016-12-01 01:32:16 +00:00
Martin Panter ed82604e3f Issue #25701: Document that some C APIs can both set and delete items
Also document that using the dedicated functions to delete items is
preferred. Using PyObject_SetAttr/String() and PySequence_SetItem/Slice() for
deletion is deprecated.
2016-11-30 10:32:40 +00:00
Serhiy Storchaka d585c52511 Issue #28496: Mark up constants 0, 1 and -1 that denote return values or
special input values as literal text.
2016-10-27 21:41:04 +03:00
Serhiy Storchaka dc0e3a8907 Issue #19795: Improved more markups of True/False. 2016-10-19 18:30:16 +03:00
Serhiy Storchaka ad13f338ce Issue #19795: Mark up None as literal text. 2016-10-19 16:29:10 +03:00
Serhiy Storchaka 0ea51b18d5 Issue #18287: PyType_Ready() now checks that tp_name is not NULL.
Original patch by Niklas Koep.
2016-10-07 23:24:35 +03:00
Martin Panter d51b0f2188 Issue #24314: Add links for general attributes like __name__, __dict__ 2016-06-18 03:57:31 +00:00
Berker Peksag 0d8657721e Issue #15657: Delete incorrect statement from PyMethodDef documentation 2016-06-12 16:37:57 +03:00
Tommy Beadle 24b9e1a00d [Issue 15476] Make "code object" its own entry in the index 2016-06-02 19:26:51 -04:00
Benjamin Peterson 382d041131 note that Py_VISIT handles NULL (closes #27183) 2016-06-02 11:35:59 -07:00
Martin Panter b44c4520d9 Issue #27125: Fix various errors like “will [be] inherited” 2016-05-29 08:13:58 +00:00
Martin Panter 4f23cabc16 Corrections for a/an in code comments and documentation 2016-05-08 13:45:55 +00:00
Serhiy Storchaka b4905efe23 Issue #26736: Used HTTPS for external links in the documentation if possible. 2016-05-07 10:50:12 +03:00
Serhiy Storchaka 9a118f1dc3 Issue #26778: Fixed "a/an/and" typos in code comment and documentation. 2016-04-17 09:37:36 +03:00
Martin Panter 6a8163a928 Correct “an” → “a” with “Unicode”, “user”, “UTF”, etc
This affects documentation and code comments.
2016-04-15 02:14:19 +00:00
Martin Panter ef85a1ac15 Issue #22836: Keep exception reports sensible despite errors 2016-02-28 00:18:43 +00:00
Martin Panter 53ae0ba6e3 Issue #26304: Change "allows to <verb>" to "allows <verb>ing" or similar
The original form is incorrect grammar and feels awkward, even though the
meaning is clear.
2016-02-10 05:44:01 +00:00
Serhiy Storchaka 36ae29c759 Issue #26198: Fixed error messages for some argument parsing errors.
Fixed the documented about buffer overflow error for "es#" and "et#" format
units.
2016-02-08 01:05:48 +02:00
Gregory P. Smith 20d4f1b9e4 Per issue21949 and issue1629: Document the Py_SIZE, Py_TYPE, Py_REFCNT macros.
This was already done in the 3.5 branch; this just does the same in the 2.7
branch.
2016-01-22 13:17:41 -08:00
Senthil Kumaran e57c957ff9 Issue26142 - Fix a formatting bug in c-api intro doc. 2016-01-17 17:05:14 -08:00
Martin Panter 4ed35fc4f3 Issue #25161: Add full stops in documentation; patch by Takase Arihiro 2015-10-10 10:52:35 +00:00
Serhiy Storchaka 1670af6c33 Added the const qualifier for char* argument of Py_EnterRecursiveCall(). 2015-06-21 16:26:28 +03:00
Raymond Hettinger 632d692e29 Issue #24161: Document that PyIter_Check() returns false positives for old-style instances. 2015-05-11 10:22:20 -07:00
Charles-François Natali 6d12c80c91 Fix PyGILState_GetThisThreadState() prototype in the API documentation. 2015-04-15 19:30:38 +01:00
Stefan Krah 1c9bf63a15 Preserve critical whitespace in Doc/*. 2015-02-01 19:49:38 +01:00
Stefan Krah 3f1ef5b756 Issue #23352: Document that Py_buffer.suboffsets must be NULL if no suboffsets
are required.
2015-02-01 19:40:50 +01:00
Georg Brandl a44ec3ff4c Closes #23181: codepoint -> code point 2015-01-14 08:26:30 +01:00
Benjamin Peterson 07f90476b9 fix instances of consecutive articles (closes #23221)
Patch by Karan Goel.
2015-01-13 09:17:24 -05:00
Victor Stinner a6066ce6b1 Closes #22580: Fix documentation of PyUnicode_Tailmatch()
The result type is Py_ssize_t (and not int).
2014-10-09 11:14:04 +02:00
Georg Brandl 8b14dd39cf Closes #10031: overhaul the "imports" section of the programming FAQ.
Remove the advice to never use relative imports.
Remove the advice to locally import modules in __init__, it is a strange practice.
Remove the advice to use "from ... import *" with some modules.
2014-10-06 16:21:08 +02:00
Georg Brandl b74cf54a64 Closes #22507: document that PyType_IsSubtype does not call __subclasscheck__. 2014-10-06 14:15:06 +02:00
Georg Brandl 3e430eba6e Remove duplicate PyLong function descriptions. 2014-09-30 23:02:52 +02:00
Serhiy Storchaka ea217728c3 Issue #20643: Fixed references to the next() method (distinguish from the
next() function).
2014-09-05 23:34:12 +03:00
Benjamin Peterson 8f25762a94 args doesn't need to be a tuple (closes #17210) 2014-07-19 16:34:33 -07:00
Stefan Krah 32ae4378b9 Issue #17145: Document array.array buffer interface limitations. 2014-04-26 22:50:25 +02:00
Benjamin Peterson 96c9a35815 PySequence_Fast generally returns a list not a tuple (closes #16395) 2014-04-08 10:48:36 -04:00
Benjamin Peterson 236d9f8cd6 the name of the slot of nb_multiply not nb_mul 2014-04-08 10:44:30 -04:00
Georg Brandl fbd2db5005 Closes #18456: Doc fix: PyDict_Update only works with dict-like objects, not key-value sequences. Patch by priyapappachan. 2014-03-25 09:34:30 +01:00
Éric Araujo 69d096597d Fix note markup (#16805).
Patch by Tshepang Lekhonkhobe, reviewed by Georg Brandl.
2014-03-12 19:35:54 -04:00
Raymond Hettinger 8b1701d394 Issue #19005: Fix documentation for PyIter_Next(). 2013-10-09 22:39:11 -07:00
Serhiy Storchaka 99a196fcfc Issue 19195: Improved cross-references in C API documentation. 2013-10-09 13:25:21 +03:00
Benjamin Peterson 29f0dc5f77 dict is also allowed (closes #19163) 2013-10-04 10:55:15 -04:00
Antoine Pitrou 59db34e4d5 Add a "skull and crossbones" to Py_AddPendingCall. 2013-09-30 21:35:44 +02:00
Serhiy Storchaka 6d5bd5258c Issue #18743: Improved cross-references to the StringIO class. 2013-08-29 11:44:44 +03:00
Antoine Pitrou 92fae55bc9 Issue #18589: fix hyperlinking of type slots (tp_*) 2013-08-01 21:17:24 +02:00
Georg Brandl 10bb21e4f9 Fix refcount leak in the reference counting example section (!). 2013-04-14 11:45:16 +02:00
Georg Brandl ba58cbe754 Closes #13638: document PyErr_SetFromErrnoWithFilenameObject,
PyErr_SetFromWindowsErrWithFilenameObject, and
PyErr_SetExcFromWindowsErrWithFilenameObject.

Note that PyErr_SetExcFromWindowsErrWithFilenameObjectAndSomeOtherParametersSoThatTheNameGetsSoLongThatNobodyIsEverGonnaUseThisStrangeFunctionForAnything is still undocumented.
2013-04-14 11:12:16 +02:00
Georg Brandl 75da35747e Backport rev. 3ae74b361f53 to 2.7 branch. 2013-03-28 13:35:18 +01:00
Georg Brandl 44ea77bd81 Closes #4159: add LaTeX tabular column specifications to tables that otherwise are cut off or have overlapping text. 2013-03-28 13:28:44 +01:00
Gregory P. Smith bcd2aa6d06 cleanup references to PyString_ APIs from 2.x in the 3.3 docs. 2013-03-22 13:49:26 -07:00