Commit Graph

862 Commits

Author SHA1 Message Date
Serhiy Storchaka 93e9fb5664
[3.6] bpo-5945: Improve mappings and sequences C API docs. (GH-7029). (GH-7049)
(cherry picked from commit f5b1183610)
2018-05-22 14:54:14 +03:00
Miss Islington (bot) 0c1e7d8122
bpo-33583: Add note in PyObject_GC_Resize() doc (GH-7021)
(cherry picked from commit 1179f4b40f)

Co-authored-by: INADA Naoki <methane@users.noreply.github.com>
2018-05-21 19:18:41 -07:00
Miss Islington (bot) e6e440ad5c
Fix C API docs: PyCapsule_Import always set an exception on failure. (GH-6967)
(cherry picked from commit bde3e0bf09)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-05-18 06:53:42 -07:00
INADA Naoki 29bc6f6347
bpo-33195: Doc: Deprecate Py_UNICODE in c-api/arg (GH-6329)
Py_UNICODE is deprecated since Python 3.3.
But the deprecation is missed in the c-api/arg document.
(cherry picked from commit 42ec190)
2018-04-05 18:08:43 +09:00
Miss Islington (bot) 18fdc87207 bpo-33126: Document PyBuffer_ToContiguous() (GH-6292) (GH-6293)
(cherry picked from commit aa50bf08e6)

Co-authored-by: Antoine Pitrou <pitrou@free.fr>
2018-03-28 17:47:34 +02:00
Miss Islington (bot) 1da0479f68
bpo-32374: m_traverse may be called with m_state=NULL (GH-5140)
Multi-phase initialized modules allow m_traverse to be called while the
module is still being initialized, so module authors may need to account
for that.
(cherry picked from commit c2b0b12d1a)

Co-authored-by: Marcel Plch <gmarcel.plch@gmail.com>
2018-03-16 23:29:30 -07:00
Miss Islington (bot) 6ae87cae09
bpo-32500: Correct the documentation for PySequence_Size() and PySequence_Length() (GH-5767)
Dropped the part that says: "For objects that do not provide sequence protocol".
(cherry picked from commit 7a1e1786f9)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2018-02-20 11:46:06 -08:00
Serhiy Storchaka 3d4a174c0e
[3.6] Make formatting of some return codes conforming to the general style. (GH-5587). (GH-5598)
(cherry picked from commit 5bb0005f9f)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-02-09 14:48:31 +02:00
Miss Islington (bot) 5869861823 Document the error return of PyLong_As* APIs. (GH-5396) (#5404)
Document the error return of PyLong_As* APIs.

A frequent Python C API usage error is neglecting to check the return
value and/or PyErr_Occurred().
(cherry picked from commit f5b04a360e)
2018-01-29 09:24:11 -08:00
Miss Islington (bot) 33febfb039 Fix PyTrace_RETURN documentation (GH-5384) (GH-5386)
It will be triggered when propagating an exception.
(cherry picked from commit 79db11ce99)
2018-01-28 23:33:23 +08:00
Miss Islington (bot) 854f0424de bpo-32687: Fix wrong meaning of args for PyTrace_LINE/CALL in documentation (GH-5361) (GH-5377)
(cherry picked from commit 9ed0aee27c)
2018-01-28 16:41:05 +08:00
Xiang Zhang fd844efa9c
bpo-17799: Explain real behaviour of sys.settrace and sys.setprofile (GH-4056) (#5298)
(cherry picked from commit 131fd7f96c)
2018-01-24 22:44:53 +08:00
Victor Stinner b92c159efa
[3.6] bpo-32555: Fix locale encodings (#5193)
On FreeBSD and Solaris, os.strerror() now always decode the byte
string from the current locale encoding, rather than using
ASCII/surrogateescape in some cases.

Changes:

* Add _Py_DecodeLocaleEx() and _Py_EncodeLocaleEx() which has an
  additional current_locale parameter.
* PyUnicode_DecodeLocale(), PyUnicode_DecodeLocaleAndSize() and
* PyUnicode_EncodeLocale() now always use the current locale
* encoding, instead of using Py_DecodeLocale()/Py_EncodeLocale().
* Document encoding in Py_DecodeLocale() and Py_EncodeLocale()
  documentations.
* Add USE_FORCE_ASCII define to not define
  decode_ascii_surrogateescape() on Android.
2018-01-15 23:43:24 +01:00
xdegaye ea5b545e38
[3.6] bpo-30696: Fix the REPL looping endlessly when no memory (GH-4160). (#4379)
(cherry picked from commit e0582a37c8)
2017-11-12 17:33:16 +01:00
Miss Islington (bot) f9387469e8 bpo-31678: Fix typo in PyDateTime_DELTA_GET_MICROSECONDS (GH-3869)
(cherry picked from commit 82cd3cede8)
2017-11-04 13:45:51 +03:00
Miss Islington (bot) 8543ce8ffd bpo-20064: Document PyObject_Malloc() (GH-4199) (#4203)
Document the following functions:

* PyObject_Malloc()
* PyObject_Calloc()
* PyObject_Realloc()
* PyObject_Free()

Fix also PyMem_RawFree() documentation.
(cherry picked from commit ec2cbdd1df)
2017-10-31 09:56:11 -07:00
Miss Islington (bot) e881302b70 [3.6] bpo-31754: Fix type of 'itemsize' in PyBuffer_FillContiguousStrides (GH-3993)
(cherry picked from commit 1b9e76ed3a)
2017-10-15 10:37:07 +03:00
Michael Seifert 51ea80697b bpo-29916: Include PyGetSetDef in C API extension documentation. (#831) (#3607)
(cherry picked from commit da67e0d644)
2017-09-16 14:29:33 +03:00
Mariatta 6a90a12470 bpo-30656: Fix Python C API Module Objects documentation (GH-2170) (GH-2230)
`PyModule_New()` now refers to `PyModule_NewObject()`
(cherry picked from commit 2d0afef82a)
2017-06-15 18:49:43 -07:00
delirious-lettuce 0702cc01fa [3.6] Fix typos in multiple `.rst` files (GH-1668) (#1702)
(cherry picked from commit 3378b2062c)
2017-05-22 00:26:01 +03:00
Mariatta ea0efa3bc1 [3.6] bpo-29751: Improve PyLong_FromString documentation (GH-915) (#1266)
(cherry picked from commit 26896f2832)
2017-04-23 21:05:01 -07:00
cocoatomo 5fb4bf91e7 bpo-19225: Remove duplicated description for standard warning categories (GH-1068) 2017-04-20 06:54:06 +03:00
Michael Seifert 05bfbcd233 [3.6] bpo-30059: Include Py_Ellipsis in C API documentation (GH-1018) (GH-1149) 2017-04-14 19:03:41 -07:00
cocoatomo d184c20e35 Keep the c-api exception doc up-to-date (#966)
cherry-pick'ed from ec1f5df..e3d6db3
2017-04-03 19:26:32 +03:00
Senthil Kumaran da6ad2f780 bpo-29917: DOC: Remove link from PyMethodDef (#890) (#894)
(cherry picked from commit c3c7ef0885)
2017-03-29 22:29:00 -07:00
Serhiy Storchaka 69eab3123e bpo-28749: Fixed the documentation of the mapping codec APIs. (#487) (#714)
Added the documentation for PyUnicode_Translate().
(cherry picked from commit c85a26628c)
2017-03-19 20:26:26 +02:00
Serhiy Storchaka 4652d82a51 bpo-29746: Update marshal docs to Python 3. (#547) (#631)
(cherry picked from commit c611a5b1d4)
2017-03-12 10:05:05 +02:00
Mariatta e9effe6bb6 fix minor bug in pymalloc. (GH-335) (GH-476)
(cherry picked from commit f669ffff60)
2017-03-06 09:15:41 -08:00
Xiang Zhang 346454c7f5 Issue #29292: Merge 3.5. 2017-01-20 11:29:48 +08:00
Xiang Zhang 6ad85bf89a Issue #29292: Update outdated doc of PyEval_EvalCodeEx.
Patch by Ammar Askar.
2017-01-20 11:29:11 +08:00
Martin Panter a27b3b3192 Issue #15657: Merge other doc fix from 3.5 2017-01-11 11:51:02 +00:00
Martin Panter 5b66723b0b Issue #15657: Delete incorrect statement from PyMethodDef documentation
Patch by Berker Peksag.
2017-01-11 11:50:06 +00:00
Martin Panter 9da31f7274 Issue #15657: METH_KEYWORDS cannot be used alone in Python 3 2017-01-11 11:41:03 +00:00
Serhiy Storchaka 44223e9550 Issue #29087: Removed the documentation of non-existing UCS4 support functions. 2016-12-28 09:19:45 +02:00
Serhiy Storchaka af9181a4f2 Issue #29087: Removed the documentation of non-existing UCS4 support functions. 2016-12-28 09:19:15 +02:00
Serhiy Storchaka a8803d21e7 Merge from 3.5. 2016-12-25 16:23:42 +02:00
Serhiy Storchaka 4398c12b47 Issue #29068: Fixed a typo in PyErr_Fetch example.
Patch by Chi Hsuan Yen.
2016-12-25 16:22:23 +02:00
Xiang Zhang 47888da90b Issue #29009: Merge 3.5. 2016-12-19 18:39:02 +08:00
Xiang Zhang bfbc29cb8f Issue #29009: Remove outdated doc of PyUnicode_RichCompare. 2016-12-19 18:35:14 +08:00
Martin Panter 21799618ec Issue #28771: Merge C API doc fix from 3.5 2016-12-10 05:57:38 +00:00
Martin Panter 7a44783b42 Issue #28771: Update tp_get/setattr signature documentation 2016-12-10 05:56:13 +00:00
Serhiy Storchaka 419967b832 Issue #28808: PyUnicode_CompareWithASCIIString() now never raises exceptions. 2016-12-06 00:13:34 +02:00
Serhiy Storchaka 9a953dbb34 Issue #28808: PyUnicode_CompareWithASCIIString() now never raises exceptions. 2016-12-06 00:17:45 +02:00
Serhiy Storchaka 01452af645 Issue #28750: Fixed docs of of unicode-escape an raw-unicode-escape C API.
Patch by Xiang Zhang.
2016-11-20 17:21:04 +02:00
Serhiy Storchaka cf36835fc5 Issue #28750: Fixed docs of of unicode-escape an raw-unicode-escape C API.
Patch by Xiang Zhang.
2016-11-20 17:20:19 +02:00
Serhiy Storchaka 92b9a1f911 Issue #19569: Suggested more appropriate replacements for deprecated Unicode
C API functions.
2016-11-20 12:14:08 +02:00
Serhiy Storchaka f675a37ed3 Issue #19569: Suggested more appropriate replacements for deprecated Unicode
C API functions.
2016-11-20 12:13:44 +02:00
Serhiy Storchaka 3b73ea1278 Issue #28701: Replace PyUnicode_CompareWithASCIIString with _PyUnicode_EqualToASCIIString.
The latter function is more readable, faster and doesn't raise exceptions.
2016-11-16 10:19:20 +02:00
Serhiy Storchaka f4934ea77d Issue #28701: Replace PyUnicode_CompareWithASCIIString with _PyUnicode_EqualToASCIIString.
The latter function is more readable, faster and doesn't raise exceptions.
2016-11-16 10:17:58 +02:00
Yury Selivanov 3479b5f888 Issue #28635: Fix a couple of missing/incorrect versionchanged tags
Patch by Elvis Pranskevichus.
2016-11-10 13:25:26 -05:00