Commit graph

223 commits

Author SHA1 Message Date
Jeroen Demeyer
7f41c8e0dd bpo-37493: use _PyObject_CallNoArg in more places (GH-14575) 2019-07-04 19:35:31 +09:00
Stéphane Wirtel
cbb6484573 Doc: Replace the deprecated highlightlang directive by highlight. (#13377)
highlightlang is deprecated since April 2018 in Sphinx.
See https://github.com/sphinx-doc/sphinx/pull/4845
2019-05-17 15:25:34 +05:30
Wu Wei
662ebd2ab2 Doc: add the missing ".tp_flags" in type definition (GH-12902) 2019-04-22 20:08:20 +09:00
Inada Naoki
c88feceb44
Doc: define PY_SSIZE_T_CLEAN always (GH-12794) 2019-04-13 10:46:21 +09:00
Caleb Marchent
42f55ee500 fix typo in doc (#12686) 2019-04-10 18:03:02 -04:00
Serhiy Storchaka
62be74290a
bpo-33012: Fix invalid function cast warnings with gcc 8. (GH-6749)
Fix invalid function cast warnings with gcc 8
for method conventions different from METH_NOARGS, METH_O and
METH_VARARGS excluding Argument Clinic generated code.
2018-11-27 13:27:31 +02:00
Serhiy Storchaka
3f819ca138
bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231) 2018-10-31 02:26:06 +02:00
Eric Snow
9e7c92193c
bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413)
The existing doc had a number of info gaps and was a little hard to use.  This patch provides several quick-reference tables as well as examples.
2018-06-14 15:46:35 -06:00
Siddhesh Poyarekar
55edd0c185 bpo-33012: Fix invalid function cast warnings with gcc 8 for METH_NOARGS. (GH-6030)
METH_NOARGS functions need only a single argument but they are cast
into a PyCFunction, which takes two arguments.  This triggers an
invalid function cast warning in gcc8 due to the argument mismatch.
Fix this by adding a dummy unused argument.
2018-04-29 21:59:33 +03:00
Serhiy Storchaka
46936d5a71
Improve highlighting of some code blocks. (GH-6401) 2018-04-08 19:18:04 +03:00
Antoine Pitrou
1d80a56173
bpo-33201: Modernize "Extension types" doc (GH-6337)
* bpo-33201: Modernize "Extension types" doc
* Split tutorial and other topics
* Some small fixes
* Address some review comments
* Rename noddy* to custom* and shoddy to sublist
* Fix markup
2018-04-07 18:14:03 +02:00
Serhiy Storchaka
5bb0005f9f
Make formatting of some return codes conforming to the general style. (#5587) 2018-02-09 13:31:19 +02:00
Sanyam Khurana
338cd83c5d bpo-25910: Link redirections in docs (#1933)
Fixes some redirection links in docs.
2018-01-20 01:25:37 +01:00
Emanuele Gaifas
cdfe910e74 Extending Python Doc minor updates (GH-4518)
Move footnote markers to be closer to the related terminology:
before the end of the sentence, instead of after.
2017-11-24 00:49:57 -08:00
Stefan Krah
ca72589bfa bpo-31443: Formulate the type slot initialization rules in terms of C99. (#3688) 2017-09-22 17:44:58 +02:00
Sergey Fedoseev
d9a2b99ac4 Fix the indentation in Extending Python code example (GH-3244)
Code was indented with three spaces.
Fixed using four spaces.
2017-08-30 07:50:40 -07:00
INADA Naoki
a6296d34a4 bpo-31095: fix potential crash during GC (GH-2974) 2017-08-24 14:55:17 +09:00
UltimateCoder
8856940cf2 bpo-28315: Improve code examples in docs (GH-1372)
Replace
   File "<stdin>", line 1, in ? 
with 
   File "<stdin>", line 1, in <module>
2017-05-03 09:46:45 -07:00
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