summaryrefslogtreecommitdiffstats
path: root/Doc/howto/clinic.rst
Commit message (Collapse)AuthorAgeFilesLines
* GH-107518: Remove the Argument Clinic How-To (#109900)Adam Turner2023-10-111-2061/+5
| | | | | * Remove the content of the Argument Clinic HOWTO * Update cross-references to the Argument Clinic * Add a note directing readers to the devguide
* gh-108494: Argument Clinic: Document how to generate code that uses the ↵Victor Stinner2023-08-301-1/+22
| | | | | | limited C API (#108584) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
* gh-107704: Argument Clinic: add support for deprecating keyword use of ↵Serhiy Storchaka2023-08-191-22/+43
| | | | | | | | | | | | parameters (GH-107984) It is now possible to deprecate passing keyword arguments for keyword-or-positional parameters with Argument Clinic, using the new '/ [from X.Y]' syntax. (To be read as "positional-only from Python version X.Y") Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* Docs: clean up Argument Clinic howto's (#107797)Erlend E. Aasland2023-08-091-10/+11
| | | | - fix formatting in @text_signature howto and NEWS entry - fix formatting and example text in deprecate-positionals howto
* gh-104683: Add --exclude option to Argument Clinic CLI (#107770)Erlend E. Aasland2023-08-081-0/+5
| | | Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* gh-86457: Add docs for Argument Clinic @text_signature directive (#107747)Erlend E. Aasland2023-08-081-0/+34
| | | Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* gh-95065: Add Argument Clinic support for deprecating positional use of ↵Erlend E. Aasland2023-08-071-0/+88
| | | | | | | | | | parameters (#95151) It is now possible to deprecate passing parameters positionally with Argument Clinic, using the new '* [from X.Y]' syntax. (To be read as "keyword-only from Python version X.Y") Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* Docs: Argument Clinic: Move the CConverter class to the reference (#107671)Erlend E. Aasland2023-08-071-64/+69
|
* Docs: Argument Clinic: Improve 'How to write a custom converter' (#107328)Erlend E. Aasland2023-08-051-24/+26
| | | | | | - Omit unneccesary wording and sentences - Don't mention implementation details (no digression, explanation) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* gh-107507: Replace 'The goals of Argument Clinic' with a summary (#107508)Erlend E. Aasland2023-07-311-54/+4
| | | | Summarise the goals of Argument Clinic in a single sentence. Mention that Argument Clinic was introduced with PEP-436.
* Docs: Argument Clinic: Restructure "Basic concepts and usage" (#106981)Erlend E. Aasland2023-07-261-43/+129
| | | | | | | | | | | | | | Split "Basic concepts and usage" into: - Reference - Terminology - CLI reference - Background - Basic concepts Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* Docs: Remove the numbered steps from the Argument Clinic tutorial (#107203)Erlend E. Aasland2023-07-261-314/+310
| | | | Instead, order the tutorial as one body of prose, making it easier to align the tutorial according to Diátaxis principles.
* Docs: Add missing markup to Argument Clinic docs (#106876)Erlend E. Aasland2023-07-241-126/+143
| | | | Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* Docs: Remove duplicate word in Argument Clinic howto heading (#107169)Hakan Celik2023-07-241-2/+2
|
* Docs: Argument Clinic: Add Background and Tutorial top-level sections (#106904)Erlend E. Aasland2023-07-211-9/+27
| | | | | | | | | | | | | | | | | | | | | Add Background as a toplevel section with the following subsections: - Background - The goals of Argument Clinic - Basic concepts and usage Rename "Converting your first function" to Tutorial. Add anchors for Background, Tutorial, and How-to Guides: - :ref:`clinic-background` - :ref:`clinic-tutorial` - :ref:`clinic-howtos` Link to these from within the Abstract. Break the compatibility paragraph out of Abstract and make it a note. Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* Docs: Argument Clinic: Group guides about default values (#106872)Erlend E. Aasland2023-07-181-20/+20
| | | | | | | | | | | | | | | | Previous ToC layout (excerpt): - How to use symbolic default values ... - How to assign default values to parameter - How to use the ``NULL`` default value - How to use expressions as default values New layout: - How to assign default values to parameter - The ``NULL`` default value - Symbolic default values - Expressions as default values
* Docs: Normalise Argument Clinic advanced topics headings (#106842)Erlend E. Aasland2023-07-181-49/+46
| | | Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* Docs: Normalize Argument Clinic How-To section capitalization (#106788)Erlend E. Aasland2023-07-151-11/+18
|
* gh-104389: Add 'unused' keyword to Argument Clinic C converters (#104390)Erlend E. Aasland2023-05-121-0/+3
| | | | | | | | | Use the unused keyword param in the converter to explicitly mark an argument as unused: /*[clinic input] SomeBaseClass.stubmethod flag: bool(unused=True) [clinic start generated code]*/
* gh-64658: Expand Argument Clinic return converter docs (#104175)Erlend E. Aasland2023-05-051-13/+28
|
* gh-98763: Prefer "python" over "python3" for command line examples in docs. ↵Mariusz Felisiak2023-01-111-1/+1
| | | | (#98761)
* docs: Change links to label refs (#98454)Stanley2022-10-261-0/+2
| | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* gh-97956: Mention `generate_global_objects.py` in `AC How-To` (#97957)Nikita Sobolev2022-10-071-1/+9
|
* gh-95007: Remove the NoneType return converter from Argument Clinic Doc (#95529)Noam Cohen2022-08-011-5/+0
| | | The converter was removed in 74b5e4ce80858ac5c7d03411cb8cce7e6865f181
* Docs: remove redundant "adverb-adjective" hyphens from compound modifiers ↵Ned Batchelder2022-07-051-3/+3
| | | | | (GH-94551) Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
* Document Py_ssize_t. (GH-92512)Julien Palard2022-05-131-1/+1
| | | | | | It fixes 252 errors from a Sphinx nitpicky run (sphinx-build -n). But there's 8182 errors left. Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* gh-92536: PEP 623: Remove wstr and legacy APIs from Unicode (GH-92537)Inada Naoki2022-05-121-4/+4
|
* bpo-46613: Add PyType_GetModuleByDef to the public API (GH-31081)Petr Viktorin2022-02-111-3/+3
| | | | | * Make PyType_GetModuleByDef public (remove underscore) Co-authored-by: Victor Stinner <vstinner@python.org>
* bpo-45320: Remove long-deprecated inspect methods (GH-28618)Hugo van Kemenade2021-10-201-3/+0
|
* bpo-42048: Clinic Howto: Document AC's defining_class converter (GH-23978)Erlend Egeberg Aasland2021-01-201-0/+62
|
* bpo-38600: NULL -> ``NULL``. (GH-17001)Serhiy Storchaka2019-10-301-1/+1
| | | Also fix some other formatting.
* Doc: Replace the deprecated highlightlang directive by highlight. (#13377)Stéphane Wirtel2019-05-171-1/+1
| | | | highlightlang is deprecated since April 2018 in Sphinx. See https://github.com/sphinx-doc/sphinx/pull/4845
* bpo-35042: Use the :pep: role where a PEP is specified (#10036)Stéphane Wirtel2018-10-261-1/+1
|
* bpo-20260: Implement non-bitwise unsigned int converters for Argument ↵Serhiy Storchaka2018-07-261-0/+6
| | | | Clinic. (GH-8434)
* Docs: be less specific about python versions (GH-6985)Eitan Adler2018-05-201-2/+2
| | | | CPython 3.5 is old now, and we don't bump this version often, so lets avoid using specific versions.
* Improve highlighting of some code blocks. (GH-6401)Serhiy Storchaka2018-04-081-17/+51
|
* bpo-29596: Improve clinic howto documentation (GH-1710)gfyoung2017-06-061-3/+3
| | | 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.
* bpo-29918: Add missed "const" modifiers in C API documentation. (#846)Serhiy Storchaka2017-03-301-1/+1
|
* Issues #28755, #28753: Merge Arg Clinic howto from 3.5Martin Panter2016-12-101-24/+39
|\
| * Issue #28755: Improve syntax highlighting in Arg Clinic howtoMartin Panter2016-12-101-15/+29
| |
| * Issue 28753: Argument Clinic howto docfix, courtesy Julien Palard.Martin Panter2016-12-101-14/+15
| |
* | Merge doc fixups from 3.5Martin Panter2016-11-211-15/+15
|\ \ | |/
| * Change double hyphens (en dashes) to em (longer) dashesMartin Panter2016-11-211-15/+15
| |
* | clinic: PY_LONG_LONG -> long longBenjamin Peterson2016-09-081-2/+2
|/
* Issue #27745: Fix some typos in Argument Clinic howto, by Lele GaifaxMartin Panter2016-08-121-4/+4
|
* Issue #26462: Doc: reduce literal_block warnings, fix syntax highlighting.Martin Panter2016-07-261-1/+3
| | | | Patch by Julien Palard.
* Issue #27626: Spelling fixes in docs, comments and internal namesMartin Panter2016-07-281-1/+1
| | | | Based on patch by Ville Skyttä.
* Issue #27130: Fix handling of buffers exceeding UINT_MAX in “zlib” moduleMartin Panter2016-07-231-6/+6
| | | | Patch by Xiang Zhang.
* Issue #25626: Change zlib to accept Py_ssize_t and cap to UINT_MAXMartin Panter2015-11-201-8/+8
| | | | | | | | | | | | | | 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.
* Issue #24232: Fix typos. Patch by Ville Skyttä.Berker Peksag2015-05-181-1/+1
|\
generated by cgit v0.12 at 2025-09-15 10:28:27 (GMT)