summaryrefslogtreecommitdiffstats
path: root/Doc/howto
Commit message (Collapse)AuthorAgeFilesLines
...
* 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
* howto/urllib2: remove link to an outdated french translation (GH-104193)Mathieu Dupuy2023-05-221-7/+0
| | | We now have our own translation and it's not outdated
* gh-103295: expose API for writing perf map files (#103546)gsallam2023-05-211-3/+1
| | | | | Co-authored-by: Aniket Panse <aniketpanse@fb.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Carl Meyer <carl@oddbird.net>
* 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-103960: Dark mode: invert image brightness (#103983)Hugo van Kemenade2023-05-101-0/+1
|
* gh-64658: Expand Argument Clinic return converter docs (#104175)Erlend E. Aasland2023-05-051-13/+28
|
* gh-101100: Fix Sphinx warnings in `curses` and `curses.ascii` modules (#103457)Hugo van Kemenade2023-05-031-21/+23
| | | | Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* GH-103484: Fix redirected permanently URLs (#104001)Rafael Fontenelle2023-05-021-1/+1
| | | | | Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
* gh-101100: Fix Sphinx warnings in `argparse` module (#103289)Hugo van Kemenade2023-04-241-7/+9
| | | | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* GH-103484: Fix broken links reported by linkcheck (#103608)Rafael Fontenelle2023-04-222-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * Doc: Fix broken links reported by linkcheck * Apply suggestions from code review - Remove extra diff line in faq/library.rst (merwok) - Use HTTPS to link Unicode 15.0.0 to solve a redirect (hugovk) - Use wayback machine link for openssl 1.1.0 instead of linking 1.1.1, "as this text mentions a feature from 1.1.0" (hugovk) Co-authored-by: Éric <merwok@netwok.org> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Doc: Make mark-up code as literal * Doc: Alphabetize items in linkcheck_ignore Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Doc: Improve comment in sphinx conf Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --------- Co-authored-by: Éric <merwok@netwok.org> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Descriptor HowTo: Update to include attributes added in Python 3.10 ↵Raymond Hettinger2023-04-221-8/+90
| | | | (GH-103666)
* gh-103596: [Enum] do not shadow mixed-in methods/attributes (GH-103600)Ethan Furman2023-04-181-3/+11
| | | | | | | | | | | | | | | | | | For example: class Book(StrEnum): title = auto() author = auto() desc = auto() Book.author.desc is Book.desc but Book.author.title() == 'Author' is commonly expected. Using upper-case member names avoids this confusion and possible performance impacts. Co-authored-by: samypr100 <3933065+samypr100@users.noreply.github.com>
* Fix syntax typo in isolating extensions doc (#103516)AN Long2023-04-141-3/+3
|
* Proofread howto/perf_profiling.rst (#103530)Boris Verkhovskiy2023-04-141-10/+10
|
* gh-103479: [Enum] require __new__ to be considered a data type (GH-103495)Ethan Furman2023-04-131-3/+5
| | | a mixin must either have a __new__ method, or be a dataclass, to be interpreted as a data-type
* gh-93910: [Enum] remove member.member deprecation (GH-103236)Ethan Furman2023-04-061-4/+3
| | | | i.e. Color.RED.BLUE is now officially supported.
* gh-103056: [Enum] use staticmethod decorator for _gnv_ (GH-103231)Ethan Furman2023-04-041-0/+1
| | | _gnv_ --> _generate_next_value_
* gh-98298, gh-74730: [Enum] update docs (GH-103163)Ethan Furman2023-04-031-0/+5
| | | | fix FlagBoundary statements add warning about reloading modules and enum identity
* gh-102582: Fix invalid JSON in Doc/howto/logging-cookbook.rst (GH-102635)Matěj Cepl2023-03-291-10/+14
|
generated by cgit v0.12 at 2025-02-18 01:30:58 (GMT)