summaryrefslogtreecommitdiffstats
path: root/Doc/howto
Commit message (Collapse)AuthorAgeFilesLines
* Descriptor HowTo: Sync the error-messages with the C code. Add tests. ↵Raymond Hettinger2023-11-251-3/+40
| | | | (gh-112403)
* Remove bogus annotations from the descriptor howto guide (#112349)Raymond Hettinger2023-11-231-3/+3
|
* gh-110812: Isolating Extension Modules HOWTO: List GC-related gotchas ↵Petr Viktorin2023-11-161-6/+97
| | | | | | (GH-111504) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
* Fix typo in perf profiling docs (#112112)Ryuji Tsutsui2023-11-151-1/+1
|
* gh-111895: Convert definition list to bullet list for readability on mobile ↵Hugo van Kemenade2023-11-091-6/+6
| | | | | (#111898) Convert definition list to bullet list for readability on mobile
* Glossary: Add "static type checker" (#111837)Jelle Zijlstra2023-11-081-2/+3
| | | Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* gh-111724: Fix doctest `ResourceWarning` in `howto/descriptor.rst` (#111725)Nikita Sobolev2023-11-041-0/+4
| | | Close database connection explicitly in test cleanup.
* gh-111181: Fix enum doctests (GH-111180)Nikita Sobolev2023-10-301-3/+6
| | | Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
* gh-89519: Remove classmethod descriptor chaining, deprecated since 3.11 ↵Raymond Hettinger2023-10-271-31/+10
| | | | (gh-110163)
* gh-110383: Italicize variable name (#111206)Nick2023-10-231-1/+1
|
* gh-110383: Added explanation about simplest regex use case for quantifiers. ↵Nick2023-10-231-0/+3
| | | | | | (#111110) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* gh-110631: Fix reST indentation (#110724)Ezio Melotti2023-10-112-15/+14
| | | | | * Fix wrong indentation in the other dirs. * Fix more wrong indentation.
* GH-107518: Remove the Argument Clinic How-To (#109900)Adam Turner2023-10-112-2062/+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-108277: Add os.timerfd_create() function (#108382)Masaru Tsuchiyama2023-10-072-0/+231
| | | | | | | | Add wrapper for timerfd_create, timerfd_settime, and timerfd_gettime to os module. Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Victor Stinner <vstinner@python.org>
* Fix env var typo in perf profiling docs (#110404)Harmen Stoppels2023-10-051-2/+1
| | | Fix typo in docs
* gh-101100: Fix references to ``URLError`` and ``HTTPError`` in ↵Yuki K2023-09-291-8/+8
| | | | | ``howto/urllib2.rst`` (#107966) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* gh-109634: Use :samp: role (GH-109635)Serhiy Storchaka2023-09-232-3/+3
|
* gh-108682: [Enum] raise TypeError if super().__new__ called in custom ↵Ethan Furman2023-08-311-1/+22
| | | | | | | | | | | __new__ (GH-108704) When overriding the `__new__` method of an enum, the underlying data type should be created directly; i.e. . member = object.__new__(cls) member = int.__new__(cls, value) member = str.__new__(cls, value) Calling `super().__new__()` finds the lookup version of `Enum.__new__`, and will now raise an exception when detected.
* 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-101100: Fix Sphinx warnings in the Logging Cookbook (#108678)Hugo van Kemenade2023-08-301-4/+11
|
* gh-107432 Update Porting Python 2 Code to Python 3 how-to (GH-107434)Daniele Procida2023-08-241-121/+94
| | | | | | | https://docs.python.org/3/howto/pyporting.html#porting-python-2-code-to-python-3 was written for another time. In this patch: - material that frames Python 3 as "new" is removed - descriptions and directions have been trimmed
* docs: fix grammar in isolating-extensions.rst (#108037)David Lechner2023-08-211-1/+1
|
* 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-107432 Fix incorrect indentation in annotations HOWTO (#107445)Daniele Procida2023-08-051-163/+163
| | | | | | gh-107432 Fix incorrect indentation in annotations document Body text in https://docs.python.org/3/howto/annotations.html was indented throughout, and was being rendered in blockquote elements.
* gh-107306: Add a Doc Entry for Py_mod_multiple_interpreters (#107403)Eric Snow2023-07-311-0/+2
| | | It was added in 3.12 for PEP 684 (per-interpreter GIL).
* 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.
* gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386)Serhiy Storchaka2023-07-291-1/+1
|
* gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)Serhiy Storchaka2023-07-271-5/+5
|
* 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.
* gh-107091: Fix some uses of :c:member: role (GH-107129)Serhiy Storchaka2023-07-261-1/+1
|
* 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
|
* gh-106948: Docs: Disable links for C standard library functions, OS utility ↵Erlend E. Aasland2023-07-231-3/+3
| | | | | functions and system calls (#107062) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* gh-107091: Fix the use of some C domain roles (#107092)Serhiy Storchaka2023-07-231-2/+2
|
* gh-101100: Fix some broken sphinx references (#107095)wulmer2023-07-234-9/+11
|
* gh-54738: Add argparse i18n howto (#104562)Tomas R2023-07-231-0/+53
|
* gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)Serhiy Storchaka2023-07-211-5/+5
|
* 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-105332: [Enum] Fix unpickling flags in edge-cases (GH-105348)Nikita Sobolev2023-06-081-1/+10
| | | | | * revert enum pickling from by-name to by-value Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
* gh-102304: doc: Add links to Stable ABI and Limited C API (#105345)Victor Stinner2023-06-061-1/+1
| | | | | | | | | * Add "limited-c-api" and "stable-api" references. * Rename "stable-abi-list" reference to "limited-api-list". * Makefile: Document files regenerated by "make regen-limited-abi" * Remove first empty line in generated files: - Lib/test/test_stable_abi_ctypes.py - PC/python3dll.c
generated by cgit v0.12 at 2024-11-29 13:37:12 (GMT)