Commit Graph

205 Commits

Author SHA1 Message Date
Serhiy Storchaka 84b8e92e46 bpo-29918: Add missed "const" modifiers in C API documentation. (#846) 2017-03-30 10:01:03 +03:00
Serhiy Storchaka 007d7ff73f Issue #28761: The fields name and doc of structures PyMemberDef, PyGetSetDef,
PyStructSequence_Field, PyStructSequence_Desc, and wrapperbase are now of
type "const char *" rather of "char *".
2016-11-22 07:58:08 +02:00
Serhiy Storchaka bb8fd5b1eb Fixed the documentation of the structure PyMethodDef.
The fields ml_name and ml_doc are of type "const char *" rather of "char *".
2016-11-21 11:38:14 +02:00
Serhiy Storchaka 06a8dea46d Fixed the documentation of the structure PyMethodDef.
The fields ml_name and ml_doc are of type "const char *" rather of "char *".
2016-11-21 11:37:18 +02:00
Martin Panter 9440787867 Issue #26638: Merge option warning fixes from 3.5 into 3.6 2016-10-30 04:21:23 +00:00
Martin Panter 5c67933940 Issue #26638: Mask undefined CLI options to defeat new Sphinx warnings 2016-10-30 04:20:17 +00:00
Serhiy Storchaka e45b7c09ec Issue #18287: PyType_Ready() now checks that tp_name is not NULL.
Original patch by Niklas Koep.
2016-10-07 23:25:46 +03:00
Serhiy Storchaka de0574bdab 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
Berker Peksag 9f4712af25 Issue #23710: Merge from 3.5 2016-08-03 12:59:16 +03:00
Berker Peksag bed6891c77 Issue #23710: Update PyObject_HEAD documentation
Since PEP 3123, PyObject_HEAD only has one field named ob_base.
Users now need to use the Py_TYPE macro instead of self->ob_type.

Initial patch by Ammar Askar.
2016-08-03 12:58:49 +03:00
Martin Panter 6a09315ff0 Issue #26462: Merge code block fixes from 3.5 2016-07-29 01:49:37 +00:00
Martin Panter 1050d2d0c7 Issue #26462: Doc: reduce literal_block warnings, fix syntax highlighting.
Patch by Julien Palard.
2016-07-26 11:18:21 +02:00
Berker Peksag d7e44b61e7 Issue #17264: Fix cross refs and a markup error in extending/building.rst 2016-04-09 09:08:26 +03:00
Berker Peksag 705c0e38c2 Issue #17264: Fix cross refs and a markup error in extending/building.rst 2016-04-09 09:08:05 +03:00
Georg Brandl 3902d62c4e merge with 3.5 2016-02-26 19:37:52 +01:00
Georg Brandl 5d94134040 Closes #25910: fix dead and permanently redirected links in the docs. Thanks to SilentGhost for the patch. 2016-02-26 19:37:12 +01:00
Terry Jan Reedy c0a732e901 Merge with 3.5 2016-01-09 12:22:13 -05:00
Terry Jan Reedy 6401e79520 Issue #26029: Finish correction. 2016-01-09 12:22:00 -05:00
Terry Jan Reedy 3acf170869 Merge with 3.5 2016-01-09 03:28:01 -05:00
Terry Jan Reedy 2a97f8a6d1 Issue #26029: Remove extraneous word. Patch by Upendra Kumar. 2016-01-09 03:27:37 -05:00
Martin Panter b4ce1fc31b Issue #5319: New Py_FinalizeEx() API to exit with status 120 on failure 2015-11-30 03:18:29 +00:00
Zachary Ware 31ce9ac867 Issue #25022: Merge with 3.4 2015-09-10 16:08:21 -05:00
Zachary Ware 3d9a9d47a8 Issue #25022: Add NEWS, fix docs to not mention the old example. 2015-09-10 15:50:58 -05:00
Martin Panter 36f22a2820 Issue #24808: Merge 3.4 into 3.5; adjust new tp_as_async field 2015-08-25 05:25:21 +00:00
Martin Panter 78d5033337 Issue #24808: Update the documentation of some PyTypeObject fields
Patch by Joseph Weston.
2015-08-25 05:06:39 +00:00
Zachary Ware c75e2dd4c6 Issue #24680: Remove random backslash. Patch by cdz. 2015-07-21 22:33:16 -05:00
Zachary Ware c8115b8ba5 Issue #24680: Merge with 3.4 2015-07-21 22:34:16 -05:00
Nick Coghlan 2ab5b092e5 Close #24458: PEP 489 documentation
Patch by Petr Viktorin.
2015-07-03 19:49:15 +10:00
Serhiy Storchaka cd881b850c Fixed documentation of functions with const char* arguments. 2015-06-21 17:12:16 +03:00
Serhiy Storchaka 03863d2b29 Fixed documentation of functions with const char* arguments. 2015-06-21 17:11:21 +03:00
Yury Selivanov f3e40fac10 Issue 24180: Documentation for PEP 492 changes. 2015-05-21 11:50:30 -04:00
R David Murray e6d3abd452 Merge: #17380: Document tp_init return value in extending docs. 2015-04-12 21:52:12 -04:00
R David Murray 354c7403c5 #17380: Document tp_init return value in extending docs.
Patch by James Powell.
2015-04-12 21:51:36 -04:00
Serhiy Storchaka 8391b728e9 Issue #22883: Update PyInt to PyLong in C API example. 2015-02-17 10:19:07 +02:00
Serhiy Storchaka df0db49b1b Issue #22883: Update PyInt to PyLong in C API example. 2015-02-17 10:18:44 +02:00
Benjamin Peterson 743ffe248c merge 3.4 2015-01-05 14:39:06 -06:00
Benjamin Peterson 63b55580fb emphasize that cffi is better than extension modules for portability 2015-01-05 14:38:46 -06:00
Georg Brandl e21a531ef1 merge with 3.4 2014-10-31 10:39:29 +01:00
Georg Brandl a4c8c47961 #22613: remaining corrections in extending/reference docs (thanks Jacques Ducasse) 2014-10-31 10:38:49 +01:00
Georg Brandl cadc3fdcb5 Merge with 3.4 2014-10-29 08:37:29 +01:00
Georg Brandl e73778c1ac Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +01:00
Berker Peksag 131caba074 Revert #22251 2014-09-28 00:01:55 +03:00
Berker Peksag 9c1dba2758 Revert #22251 2014-09-28 00:00:58 +03:00
Berker Peksag f7fee33104 Issue #22251: Fix ReST markup to avoid errors building docs. 2014-09-27 23:22:35 +03:00
Berker Peksag 3749404ba5 Issue #22251: Fix ReST markup to avoid errors building docs. 2014-09-27 23:21:35 +03:00
Victor Stinner 25e014bd91 Issue #18395, #22108: Update embedded Python examples to decode correctly
command line parameters: use Py_DecodeLocale() and PyUnicode_DecodeFSDefault().
2014-08-01 12:28:49 +02:00
Larry Hastings 3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
Nick Coghlan f7614d55a2 Close #19407: New installation & distribution guides
- based on pip and other PyPA tools
- includes references to the new Python Packaging User Guide
  where appropriate (and the relevant section is at least
  partially filled in)
- started new FAQ sections
- both guides aim to introduce users to basic open source
  concepts if they aren't aware of them
- existing guides have been relocated (now linked from the
  distutils docs) rather then removed, since there is
  some needed material that has yet to be relocated to the
  distutils docs as a reference for the legacy formats
2014-03-13 22:13:45 +10:00
Nick Coghlan 1f609e9b02 Issue #19407: merge PPUG notes from 3.3 2013-12-10 21:31:14 +10:00
Nick Coghlan b5c4fd0a96 Issue #19407: add Python Packaging User Guide notes
The stdlib docs for package distribution and building extensions
are rather dated, and that isn't expected to change for 2.7 and
3.3.

The Python Packaging User Guide isn't complete either, but it's
already a much better road map for new users than the existing
stdlib docs.
2013-12-10 21:24:55 +10:00
Serhiy Storchaka d51f42372b Issue 19195: Improved cross-references in C API documentation. 2013-10-09 13:26:57 +03:00
Serhiy Storchaka 0b68a2d675 Issue 19195: Improved cross-references in C API documentation. 2013-10-09 13:26:17 +03:00
Georg Brandl 6d7d6cf76e merge with 3.3 2013-10-06 20:46:15 +02:00
Georg Brandl a072de14be Extending example: use Py_RETURN_NONE 2013-10-06 20:46:08 +02:00
Georg Brandl 4f198de5b2 merge with 3.3 2013-10-06 18:37:30 +02:00
Georg Brandl 7d07833655 Closes #17725: small grammar fix. 2013-10-06 18:36:34 +02:00
Georg Brandl 6231e52940 merge with 3.3 2013-10-06 13:15:16 +02:00
Georg Brandl 49c6fc9679 Minor improvement: add indication that the main function goes on. 2013-10-06 13:14:10 +02:00
Georg Brandl 8ae2ab5d53 merge with 3.3 2013-10-06 11:02:46 +02:00
Georg Brandl 337672b76c Small clarification in extending docs. 2013-10-06 11:02:38 +02:00
Antoine Pitrou a68cbfa556 Issue #18589: fix hyperlinking of type slots (tp_*) 2013-08-01 21:14:43 +02:00
Antoine Pitrou 39668f57f4 Issue #18589: fix hyperlinking of type slots (tp_*) 2013-08-01 21:12:45 +02:00
Antoine Pitrou 8547a0e29b Merge doc fix 2013-07-30 20:09:36 +02:00
Antoine Pitrou 3ab7b0aabb Simplify example of PyErr_Fetch() use 2013-07-30 20:09:03 +02:00
Antoine Pitrou 796564c27b Issue #18112: PEP 442 implementation (safe object finalization). 2013-07-30 19:59:21 +02:00
Ned Deily 2c72b51c44 Issue #18164: merge from 3.3 2013-06-24 14:23:35 -07:00
Ned Deily 51cee7d24a Issue #18164: Clarify the embedding docs regarding link options. 2013-06-24 14:22:09 -07:00
Ned Deily ecf0851809 Fix typo in embedding doc and update examples to 3.3. 2013-05-26 18:53:39 -07:00
Ned Deily e7b47dda64 Fix typo in embedding doc and update examples to 3.4. 2013-05-26 18:57:00 -07:00
Andrew Svetlov 59d6d2dbeb #17688: fix declaration for richcmp example in the docs.
Thanks to Daniel Mullner
2013-04-12 16:08:40 +03: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
Gregory P. Smith 4b52ae8f97 Clean up references to the no longer existing PyString_ APIs in our docs. 2013-03-22 13:43:30 -07:00
Ezio Melotti ff3f333605 #17256: merge with 3.2. 2013-02-22 07:51:18 +02:00
Ezio Melotti a19ebdb44a #17256: fix syntax highlight in embedding example. Patch by Kushal Das. 2013-02-22 07:46:22 +02:00
Chris Jerdonek bb4e941c6d Add a str class entry to the "Text Sequence Type" section (issue #16209).
This commit also moves the documentation for the str built-in function to
the new class entry.  Links to :class:`str` now go to the class entry with
the string methods immediately afterwards.
2012-11-28 01:38:40 -08:00
Georg Brandl ed71918d12 merge with 3.2 2012-11-02 07:34:46 +01:00
Georg Brandl 4552e3f95c Grammar touchup. 2012-11-02 07:34:37 +01:00
Andrew Svetlov 694f9ce343 Merge issue #16370: Mention Py_SetProgramName in example for very high level embedding. 2012-10-31 16:03:44 +02:00
Andrew Svetlov e1fa22a8ae Issue #16370: Mention Py_SetProgramName in example for very high level embedding. 2012-10-31 16:03:14 +02:00
Chris Jerdonek d285029ee8 Merge from 3.2: remove unneeded "Release" and "Date" markers from index pages. 2012-10-28 11:10:24 -07:00
Chris Jerdonek 8b7f9f581d Remove unneeded "Release" and "Date" markers from doc index pages. 2012-10-28 11:08:26 -07:00
Jesus Cea 494502756e MERGE: Closes #15953: Incorrect some fields declaration in the PyTypeObject documentation 2012-09-28 16:35:21 +02:00
Jesus Cea 33b5769db5 Closes #15953: Incorrect some fields declaration in the PyTypeObject documentation 2012-09-28 16:34:45 +02:00
Eli Bendersky bdbc0b08d0 merge 3.2 2012-08-15 14:51:08 +03:00
Eli Bendersky 8f773493b6 Issue #15656: fixing code sample in extending doc 2012-08-15 14:49:49 +03:00
Georg Brandl c9d2fc390d Merge with 3.2. 2012-07-01 09:56:07 +02:00
Georg Brandl 3aa0c9dcf3 Fix inconsistent function name in embedding howto. 2012-07-01 09:43:20 +02:00
Antoine Pitrou a6bc4b4c85 Issue #14933: fix misleading doc about weakref support in extension types. 2012-06-15 19:12:04 +02:00
Antoine Pitrou 13775221e0 Issue #14933: fix misleading doc about weakref support in extension types. 2012-06-15 19:11:31 +02:00
Eli Bendersky 49ac6f4492 Some corrections for the Doc/extending documentation. Closes #14129 2012-02-27 19:18:35 +02:00
Eli Bendersky 44fb613816 fix Doc/extending/extending.rst typo 2012-02-11 10:27:31 +02:00
Éric Araujo cd0d951a70 Merge edits from 3.2 (#13716, #1040439, #2945, #13770, #6715) 2012-02-05 13:49:59 +01:00
Éric Araujo 9c7b9190c3 Markup improvements for the embedding CPython doc patch from #1040439 2012-01-15 02:31:58 +01:00
Antoine Pitrou 97ba26bf72 Issue #1040439: better document how to compile and link an embedded Python interpreter.
Still lacks docs for Windows (anyone?).
2011-11-30 21:20:01 +01:00
Antoine Pitrou 71bca3495d Issue #1040439: better document how to compile and link an embedded Python interpreter.
Still lacks docs for Windows (anyone?).
2011-11-30 21:19:21 +01:00
Eli Bendersky 17e92cf9a6 Merge from 3.2
Issue #12672: remove confusing part of sentence in documentation
2011-08-19 06:31:10 +03:00
Eli Bendersky 729a42f263 Issue #12672: remove confusing part of sentence in documentation 2011-08-19 06:29:51 +03:00
Eli Bendersky 47fe5c0d51 Issue #12672: fix code samples in extending/newtypes.html for PEP-7 compliance 2011-08-12 11:40:39 +03:00
Georg Brandl 59b44721e3 Remove mentions of the Demo directory. 2010-12-30 22:12:40 +00:00
Georg Brandl 15641925b8 Fix advice: call PyType_Ready to fill in ob_type of custom types. 2010-12-28 09:29:19 +00:00