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
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
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
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
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
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
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
1050d2d0c7
Issue #26462 : Doc: reduce literal_block warnings, fix syntax highlighting.
...
Patch by Julien Palard.
2016-07-26 11:18:21 +02: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
Yury Selivanov
f3e40fac10
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -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
df0db49b1b
Issue #22883 : Update PyInt to PyLong in C API example.
2015-02-17 10:18:44 +02:00
Berker Peksag
9c1dba2758
Revert #22251
2014-09-28 00:00:58 +03:00
Berker Peksag
3749404ba5
Issue #22251 : Fix ReST markup to avoid errors building docs.
2014-09-27 23:21:35 +03: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
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
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
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
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
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
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
60203b41b0
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
Georg Brandl
6faee4e2ce
#9911 : doc copyedits.
2010-09-21 14:48:28 +00:00
R. David Murray
bcb8d3a0a5
Merged revisions 81586 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/trunk
........
r81586 | r.david.murray | 2010-05-28 14:08:11 -0400 (Fri, 28 May 2010) | 2 lines
Make reference to Generic Attribute Management a hyperlink.
........
2010-06-01 01:11:18 +00:00
Georg Brandl
7bc6e4fd06
Merged revisions 79184-79185 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/trunk
........
r79184 | georg.brandl | 2010-03-21 10:58:36 +0100 (So, 21 Mär 2010) | 1 line
Update text for newest US DST regulation. The sample file already has the calculation right.
........
r79185 | georg.brandl | 2010-03-21 11:02:47 +0100 (So, 21 Mär 2010) | 1 line
Include structmember.h correctly.
........
2010-03-21 10:03:36 +00:00
Georg Brandl
22b3431426
Merged revisions 74209 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/trunk
........
r74209 | georg.brandl | 2009-07-26 16:37:28 +0200 (So, 26 Jul 2009) | 1 line
builtin -> built-in.
........
2009-07-26 14:54:51 +00:00
Georg Brandl
890a49a627
#1717 : fix-up docs for comparison in newtypes document.
2009-03-31 18:56:38 +00:00
Georg Brandl
21151760d9
#5548 : do return the new module from PyMODINIT_FUNC functions.
2009-03-31 15:52:41 +00:00
Georg Brandl
ec12e82952
#5360 : replace PyObject_HEAD_INIT by PyVarObject_HEAD_INIT.
2009-02-27 17:11:23 +00:00
Georg Brandl
f341acd5b5
#5360 : remove RO which has been kicked from 3k.
2009-02-27 17:03:38 +00:00
Mark Dickinson
9f9892648f
Issue #1717 , continued: Doc fixes and other cleanup related
...
to renaming of tp_compare.
2009-02-02 21:29:40 +00:00
Georg Brandl
06788c9fe4
Fix a few remaining problems found by rstlint.
2009-01-03 21:31:47 +00:00