Erlend Egeberg Aasland
e982fe496b
bpo-42048: Clinic Howto: Document AC's defining_class converter (GH-23978)
2021-01-20 12:19:57 +01:00
Serhiy Storchaka
e835b31d2b
bpo-38600: NULL -> ``NULL``. (GH-17001)
...
Also fix some other formatting.
2019-10-30 21:37:16 +02: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
Stéphane Wirtel
12e696b4f0
bpo-35042: Use the :pep: role where a PEP is specified ( #10036 )
2018-10-26 15:58:26 -07:00
Serhiy Storchaka
7cb7bcff20
bpo-20260: Implement non-bitwise unsigned int converters for Argument Clinic. (GH-8434)
2018-07-26 13:22:16 +03:00
Eitan Adler
9572132ab3
Docs: be less specific about python versions (GH-6985)
...
CPython 3.5 is old now, and we don't bump this version often,
so lets avoid using specific versions.
2018-05-20 17:38:01 +03:00
Serhiy Storchaka
46936d5a71
Improve highlighting of some code blocks. (GH-6401)
2018-04-08 19:18:04 +03:00
gfyoung
ec19ba210b
bpo-29596: Improve clinic howto documentation (GH-1710)
...
Clarify that `two-pass` buffer can only be dumped once, and it prints out all text sent to it during all processing, even from Clinic blocks *after* the dumping point.
2017-06-06 12:23:52 -07:00
Serhiy Storchaka
84b8e92e46
bpo-29918: Add missed "const" modifiers in C API documentation. ( #846 )
2017-03-30 10:01:03 +03:00
Martin Panter
2fed8cd6f0
Issues #28755 , #28753 : Merge Arg Clinic howto from 3.5
2016-12-10 04:14:02 +00:00
Martin Panter
cfa9bad4b2
Issue #28755 : Improve syntax highlighting in Arg Clinic howto
2016-12-10 04:10:45 +00:00
Martin Panter
a277c130f7
Issue 28753: Argument Clinic howto docfix, courtesy Julien Palard.
2016-12-10 03:49:12 +00:00
Martin Panter
99b6f28351
Merge doc fixups from 3.5
2016-11-21 04:22:22 +00:00
Martin Panter
357ed2e577
Change double hyphens (en dashes) to em (longer) dashes
2016-11-21 00:15:20 +00:00
Benjamin Peterson
cc854499e4
clinic: PY_LONG_LONG -> long long
2016-09-08 09:29:11 -07:00
Martin Panter
b4a2b36c99
Issue #27745 : Fix some typos in Argument Clinic howto, by Lele Gaifax
2016-08-12 12:02:03 +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
Martin Panter
eb9957065a
Issue #27626 : Spelling fixes in docs, comments and internal names
...
Based on patch by Ville Skyttä.
2016-07-28 01:11:04 +00:00
Martin Panter
84544c1020
Issue #27130 : Fix handling of buffers exceeding UINT_MAX in “zlib” module
...
Patch by Xiang Zhang.
2016-07-23 03:02:07 +00:00
Martin Panter
e99e97762c
Issue #25626 : Change zlib to accept Py_ssize_t and cap to UINT_MAX
...
The underlying zlib library stores sizes in “unsigned int”. The corresponding
Python parameters are all sizes of buffers filled in by zlib, so it is okay
to reduce higher values to the UINT_MAX internal cap. OverflowError is still
raised for sizes that do not fit in Py_ssize_t.
Sizes are now limited to Py_ssize_t rather than unsigned long, because Python
byte strings cannot be larger than Py_ssize_t. Previously this could result
in a SystemError on 32-bit platforms.
This resolves a regression in the gzip module when reading more than UINT_MAX
or LONG_MAX bytes in one call, introduced by revision 62723172412c.
2015-11-20 08:13:35 +00:00
Berker Peksag
fee05daef8
Issue #24232 : Fix typos. Patch by Ville Skyttä.
2015-05-19 01:38:05 +03:00
Berker Peksag
315e104d11
Issue #24232 : Fix typos. Patch by Ville Skyttä.
2015-05-19 01:36:55 +03:00
Tal Einat
97fceee3b9
Argument Clinic: added missing bit of info in howto
2015-05-16 14:12:15 +03:00
Larry Hastings
38337d1e15
Issue #24000 : Improved Argument Clinic's mapping of converters to legacy
...
"format units". Updated the documentation to match.
2015-05-07 23:30:09 -07:00
Donald Stufft
8b852f111e
Fix Issue #21528 - Fix documentation typos
2014-05-20 12:58:38 -04:00
Larry Hastings
7726ac9163
#Issue 20456: Several improvements and bugfixes for Argument Clinic,
...
including correctly generating code for Clinic blocks inside C
preprocessor conditional blocks.
2014-01-31 22:03:12 -08:00
Larry Hastings
0e25410319
Documentation fixes, including fixing "suspicious" problems.
2014-01-26 00:42:02 -08:00
Ezio Melotti
a3642b67ca
#20348 : fix headers markup in Argument Clinic howto. Patch by Moritz Neeb.
2014-01-25 17:27:46 +02:00
Larry Hastings
42d9e1b9f3
Doc fixes for Argument Clinic.
2014-01-22 05:49:11 -08:00
Larry Hastings
b7ccb20423
Issue #20294 : Argument Clinic now supports argument parsing for __new__ and
...
__init__ functions.
2014-01-18 23:50:21 -08:00
Larry Hastings
537d760766
Doc improvements for Clinic howto "Goals" section.
2014-01-18 01:08:50 -08:00
Larry Hastings
bebf73511a
Issue #20287 : Argument Clinic's output is now configurable, allowing
...
delaying its output or even redirecting it to a separate file.
2014-01-17 17:47:17 -08:00
Larry Hastings
2a727916c5
Issue #20226 : Major improvements to Argument Clinic.
...
* You may now specify an expression as the default value for a
parameter! Example: "sys.maxsize - 1". This support is
intentionally quite limited; you may only use values that
can be represented as static C values.
* Removed "doc_default", simplified support for "c_default"
and "py_default". (I'm not sure we still even need
"py_default", but I'm leaving it in for now in case a
use presents itself.)
* Parameter lines support a trailing '\\' as a line
continuation character, allowing you to break up long lines.
* The argument parsing code generated when supporting optional
groups now uses PyTuple_GET_SIZE instead of PyTuple_GetSize,
leading to a 850% speedup in parsing. (Just kidding, this
is an unmeasurable difference.)
* A bugfix for the recent regression where the generated
prototype from pydoc for builtins would be littered with
unreadable "=<object ...>"" default values for parameters
that had no default value.
* Converted some asserts into proper failure messages.
* Many doc improvements and fixes.
2014-01-16 11:32:01 -08:00
Larry Hastings
4a714d48ad
Issue #20268 : Argument Clinic now supports cloning the parameters
...
and return converter from existing functions.
2014-01-14 22:22:41 -08:00
Larry Hastings
0191be3899
Minor doc fix in Clinic howto.
2014-01-12 13:57:36 -08:00
Larry Hastings
4a55fc5a9d
Issue #20214 : Fixed a number of small issues and documentation errors in
...
Argument Clinic (see issue for details).
2014-01-12 11:09:57 -08:00
Zachary Ware
c1cb227b3f
Closes #20200 : Argument Clinic custom converter example should be in a
...
'python' clinic block, not a 'clinic' clinic block. Patch written by
Ryan Smith-Roberts.
2014-01-09 21:41:23 -06:00
Larry Hastings
61272b77b0
Issue #19273 : The marker comments Argument Clinic uses have been changed
...
to improve readability.
2014-01-07 12:41:53 -08:00
Larry Hastings
77561cccb2
Issue #20141 : Improved Argument Clinic's support for the PyArg_Parse "O!"
...
format unit.
2014-01-07 12:13:13 -08:00
Larry Hastings
6d2ea21337
Argument Clinic: fixed test suite, improved howto.
2014-01-05 02:50:45 -08:00
Larry Hastings
78cf85c669
Issue #19659 : Added documentation for Argument Clinic.
2014-01-04 12:44:57 -08:00