summaryrefslogtreecommitdiffstats
path: root/Doc/library
Commit message (Collapse)AuthorAgeFilesLines
* [3.12] Docs: Update and proofread `library/venv.rst` (GH-124121) (#124680)Hugo van Kemenade2024-09-301-9/+119
| | | | | | | | | | | | | | | | * [3.12] Docs: Update and proofread `library/venv.rst` (GH-124121) (cherry picked from commit 23e812b84ae688a56a1011ed69a0d178c70e35ea) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> * Remove 3.13 docs --------- Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] gh-123223: Adding hyperlink of argument in warnings.catch_warnings: ↵Miss Islington (bot)2024-09-301-0/+3
| | | | | | | | (GH-123231) (#124527) gh-123223: Adding hyperlink of argument in warnings.catch_warnings: (GH-123231) (cherry picked from commit 828583a7855f15edc96e6721c226ace098ba463b) Co-authored-by: Damien <81557462+Damien-Chen@users.noreply.github.com>
* [3.12] Docs: improve generic `typing.NamedTuple` example (GH-124739) (#124765)Miss Islington (bot)2024-09-291-1/+3
| | | | | | Docs: improve generic `typing.NamedTuple` example (GH-124739) (cherry picked from commit 76fbee642e78eacf3866102f31e0ac969b57f1e6) Co-authored-by: CBerJun <121291537+CBerJun@users.noreply.github.com>
* [3.12] gh-61181: Fix support of choices with string value in argparse ↵Miss Islington (bot)2024-09-291-1/+1
| | | | | | | | (GH-124578) (GH-124756) Substrings of the specified string no longer considered valid values. (cherry picked from commit f1a2417b9e2993e584610851ac004c8b0599b323) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.12] docs: improve venv docs (GH-124540) (#124728)Jelle Zijlstra2024-09-281-27/+24
| | | | | | | | | | - Move "versionchanged" notes that apply to the whole class to the end of the class docs - Remove or move notes next to the method list that apply to individual methods. - Mark up parameters using the appropriate syntax - Do not capitalize "boolean" - Shorten some text (cherry picked from commit c976d789a98047ae7ddec6d13c9ea7086d9fa3f9)
* [3.12] gh-90190: Add doc for using `singledispatch` with precise collection ↵Miss Islington (bot)2024-09-271-0/+19
| | | | | | type hints (GH-116544) (#124711) Co-authored-by: Matt Delengowski <matt.delengowski@gmail.com>
* [3.12] gh-118181: Fix parameter markup in AST docs (GH-124473). (#124705)Tomas R2024-09-271-6/+6
| | | (cherry picked from commit 09aebb1fbc0c1d771d4942844d5e2077fcdf56c9)
* [3.12] gh-119004: fix a crash in equality testing between `OrderedDict` ↵Miss Islington (bot)2024-09-271-2/+5
| | | | | | | | (GH-121329) (#124508) gh-119004: fix a crash in equality testing between `OrderedDict` (GH-121329) (cherry picked from commit 38a887dc3ec52c4a7222279bf4b3ca2431b86de9) Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.12] Fixup indentation for docs on `ModuleSpec` attributes (#124681) (#124686)Alex Waygood2024-09-271-43/+36
| | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* [3.12] gh-123560: Correct docs for "empty" format type for floats ↵Miss Islington (bot)2024-09-261-3/+5
| | | | | | | | (GH-123561) (#124597) gh-123560: Correct docs for "empty" format type for floats (GH-123561) (cherry picked from commit 274d9ab619b8150a613275835234ea9ef935f21f) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
* [3.12] gh-124234: Improve docs for `Mock.reset_mock` (GH-124237) (#124592)Miss Islington (bot)2024-09-261-10/+33
| | | | | | gh-124234: Improve docs for `Mock.reset_mock` (GH-124237) (cherry picked from commit 19fed6cf6eb51044fd0c02c6338259e2dd7fd462) Co-authored-by: sobolevn <mail@sobolevn.me>
* [3.12] Doc: Improve documentation for the ``path`` argument in ↵Tom Most2024-09-261-5/+7
| | | | ``shutil.which()`` (GH-124494) (#124576)
* [3.12] gh-101100: Add a table of class attributes to the "Custom classes" ↵Alex Waygood2024-09-2514-84/+67
| | | | section of the data model docs (#124480) (#124558)
* [3.12] gh-108951: Document how to terminate an asyncio.TaskGroup (GH-123837) ↵Miss Islington (bot)2024-09-251-0/+47
| | | | | | | | | | | | (#123957) gh-108951: Document how to terminate an asyncio.TaskGroup (GH-123837) We don't want to add another API, since the recipe is straightforward and rarely needed. The advantage is that we could backport this to the earliest Python version that has taskgroups (3.11, alas in security mode already, so we'll just do 3.12 and 3.13). (cherry picked from commit ef05801ba0cbf090034df17e2a0420fb42c2d538) Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.12] gh-123445: calendar: Improve descriptions for day and month ↵Miss Islington (bot)2024-09-251-4/+20
| | | | | | | | | | | attributes (GH-123483) (#124501) gh-123445: calendar: Improve descriptions for day and month attributes (GH-123483) (cherry picked from commit 8447c933da308939b06e33544ca9abc9fc46aa8b) Co-authored-by: Mat S <mscull@gmail.com> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> Co-authored-by: Eric V. Smith <ericvsmith@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.12] GH-87358: Add clarification about nargs and default argparse ↵Miss Islington (bot)2024-09-241-0/+3
| | | | | | behaviour (GH-124094) (#124441) Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>
* [3.12] gh-124120: Document `Annotated.__origin__` (GH-124125) (#124417)Miss Islington (bot)2024-09-241-0/+18
| | | | | | | | gh-124120: Document `Annotated.__origin__` (GH-124125) (cherry picked from commit faef3fa653f2901cc905f98eae0ddcd8dc334d33) Co-authored-by: sobolevn <mail@sobolevn.me> Co-authored-by: Brian Schubert <brianm.schubert@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-65169: Clarify prog default in argparse (GH-31602) (GH-124431)Miss Islington (bot)2024-09-241-4/+5
| | | | | (cherry picked from commit e69ff34e81eceb69de6623205c87e0145f1831e4) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* [3.12] GH-79714: Add mention of stderr for clarity to ArgumentParser.exit() ↵Savannah Ostrowski2024-09-231-4/+4
| | | | | | (GH-123932) (GH-124356) (cherry picked from commit 5f5c0b9c23238dc0a1fdb764f625ae0cc5604519)
* [3.12] gh-124130: Notes on empty string corner case of category `\B` ↵Miss Islington (bot)2024-09-231-0/+6
| | | | | | | | | | (GH-124133) (#124329) gh-124130: Notes on empty string corner case of category `\B` (GH-124133) (cherry picked from commit d3e79d75d164c338a64fd66edb26e69c501cee58) Signed-off-by: y5c4l3 <y5c4l3@proton.me> Co-authored-by: Y5 <124019959+y5c4l3@users.noreply.github.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.12] Fix typo in XMLParser doc (GH-124129) (#124281)Miss Islington (bot)2024-09-201-1/+1
| | | | | | Fix typo in XMLParser doc (GH-124129) (cherry picked from commit 622368d99c986ca1a9bdba951ac53f42d7ee6fca) Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
* [3.12] GH-103484: Fix broken links reported by linkcheck (GH-124169) (#124180)Miss Islington (bot)2024-09-172-2/+2
| | | | | | GH-103484: Fix broken links reported by linkcheck (GH-124169) (cherry picked from commit ab80c6b402eeec379315fa3df111f6bec2de6900) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
* [3.12] Use pep role instead of url (GH-121611) (#124173)Miss Islington (bot)2024-09-173-25/+23
| | | | Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
* [3.12] GH-103484: Fix permanently redirects reported by linkcheck ↵Miss Islington (bot)2024-09-177-14/+14
| | | | | | | | (GH-124144) (GH-124152) Fix redirects reported by linkcheck, update docs conf.py checks. (cherry picked from commit 0a32c6959c265d21d7c43fe8e4aefc8c0983e85e) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
* [3.12] Normalize cdecl formatting as found elsewhere on ctypes.rst ↵Miss Islington (bot)2024-09-131-1/+1
| | | | | | (GH-121379) (#124057) Co-authored-by: utkonos <utkonos@users.noreply.github.com>
* [3.12] gh-118577: Clarify that inspect.BoundArguments prefers to put values ↵Miss Islington (bot)2024-09-121-1/+2
| | | | | | | in args (GH-119936) (GH-124004) (cherry picked from commit 8e99495701737c9d9706622f59581213ef163b23) Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
* [3.12] gh-123905: Update TOML description to include version number ↵Miss Islington (bot)2024-09-111-1/+1
| | | | (GH-123906) (#123907)
* [3.12] Mention `curl` in `contextvars` docs (GH-123838) (#123869)Miss Islington (bot)2024-09-091-4/+6
| | | | | | Mention `curl` in `contextvars` docs (GH-123838) (cherry picked from commit b950831c941a37c37b68a771610e072d11d33331) Co-authored-by: sobolevn <mail@sobolevn.me>
* [3.12] gh-123789: `secrets.randbits` returns only non-negative int ↵Miss Islington (bot)2024-09-081-1/+1
| | | | | | | | (GH-123801) (#123831) gh-123789: `secrets.randbits` returns only non-negative int (GH-123801) (cherry picked from commit beee91cdcc0dbecab252f7c5c7c51e2adb8edc26) Co-authored-by: Wulian <1055917385@qq.com>
* [3.12] Remove excessive backticks in logging doc (GH-123813) (#123817)Miss Islington (bot)2024-09-071-2/+2
| | | | | | Remove excessive backticks in logging doc (GH-123813) (cherry picked from commit 93050e46144c5864fbf2b39eac798387d5758a2d) Co-authored-by: Wei-Hsiang (Matt) Wang <mattwang44@gmail.com>
* [3.12] gh-123523: Rework typing documentation for generators and coroutines, ↵Alex Waygood2024-09-062-89/+97
| | | | | and link to it from `collections.abc` docs (#123544) (#123792) Co-authored-by: Stanislav Terliakov <50529348+sterliakov@users.noreply.github.com>
* [3.12] gh-123207: Clarify the documentation for the mro lookup for super() ↵Miss Islington (bot)2024-09-061-4/+4
| | | | | | | (GH-123417) (#123733) (cherry picked from commit 327463aef173a1cb9659bccbecfff4530bbe6bbf) Co-authored-by: Pieter Eendebak <pieter.eendebak@gmail.com>
* [3.12] gh-102988: Adjust version numbers in versionadded directives (GH-123771)Petr Viktorin2024-09-061-2/+2
|
* [3.12] [CVE-2023-27043] gh-102988: Reject malformed addresses in ↵Petr Viktorin2024-09-061-4/+15
| | | | | | | | | | | | | email.parseaddr() (GH-111116) (#123766) Detect email address parsing errors and return empty tuple to indicate the parsing error (old API). Add an optional 'strict' parameter to getaddresses() and parseaddr() functions. Patch by Thomas Dwyer. Co-Authored-By: Thomas Dwyer <github@tomd.tel> (cherry picked from commit 4a153a1d3b18803a684cd1bcc2cdf3ede3dbae19) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.12] gh-123213: Fixed xml.etree.ElementTree.Element.extend and assignment ↵Miss Islington (bot)2024-09-061-1/+1
| | | | | | to no longer hide exceptions (GH-123214) (#123258) Co-authored-by: Bar Harel <bharel@barharel.com>
* [3.12] gh-103066: Add links and `help` in site.py constants (GH-103777) ↵Miss Islington (bot)2024-09-062-2/+12
| | | | | | | | | | (#123763) Co-authored-by: David Caron <dcaron05@gmail.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Łukasz Langa <lukasz@langa.pl> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-85453: Improve instance attributes mark up on datetime.rst ↵Miss Islington (bot)2024-09-051-9/+15
| | | | | | | (GH-123655) (#123741) Co-authored-by: edson duarte <eduarte.uatach@gmail.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.12] gh-123392: Clarify wording regarding parameters that are functions to ↵Miss Islington (bot)2024-09-051-38/+36
| | | | | | | be called (GH-123394) (GH-123665) (cherry picked from commit c08ede27140121a919e884c7e8dfdce7b1a2e906) Co-authored-by: ryan-duve <ryan-duve@users.noreply.github.com>
* [3.12] gh-118508: Clarify which characters are matched by `\s` (GH-119155) ↵Miss Islington (bot)2024-09-041-4/+3
| | | | | | | | | | (#123671) gh-118508: Clarify which characters are matched by `\s` (GH-119155) Clarify re syntax (cherry picked from commit 22fdb8cf899d2dd29f2ac0bf61309af6809719fb) Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
* [3.12] gh-123517: Remove unnecessary `:meth:` parentheses (gh-123518) ↵Wei-Hsiang (Matt) Wang2024-09-0220-61/+61
| | | | (GH-123576)
* [3.12] gh-123570: Add link to `weakref.ref` from `weakref_slot` docs in ↵Miss Islington (bot)2024-09-021-1/+2
| | | | | | | | `dataclasses` (GH-123571) (#123595) gh-123570: Add link to `weakref.ref` from `weakref_slot` docs in `dataclasses` (GH-123571) (cherry picked from commit c3ed775899eedd47d37f8f1840345b108920e400) Co-authored-by: sobolevn <mail@sobolevn.me>
* [3.12] gh-91126: Docs and tests for slotted dataclasses with ↵Miss Islington (bot)2024-09-011-4/+15
| | | | | | | | `__init_subclass__` (GH-123342) (#123569) gh-91126: Docs and tests for slotted dataclasses with `__init_subclass__` (GH-123342) (cherry picked from commit 75e72822a390df81ca11355d8e0aac88e4046c27) Co-authored-by: sobolevn <mail@sobolevn.me>
* [3.12] gh-123550: Fix code snippet of `BUILD_TUPLE` in `dis` docs ↵Miss Islington (bot)2024-09-011-1/+1
| | | | (GH-123551) (#123556)
* [3.12] gh-123494: Improve documentation for ``webbrowser`` return types ↵Miss Islington (bot)2024-09-011-0/+7
| | | | | | | | | | (GH-123495) (#123549) gh-123494: Improve documentation for ``webbrowser`` return types (GH-123495) Document the return value for ``webbrowser.open*()``. (cherry picked from commit 0b6acfee04b30e7993314723c614625ddd90ae6e) Co-authored-by: Aarni Koskela <akx@iki.fi>
* [3.12] gh-123492: Remove unnecessary `:func:` parentheses (gh-123493) (#123512)Wei-Hsiang (Matt) Wang2024-08-3022-38/+38
|
* [3.12] gh-82378: Document the difference between sys.tracebacklimit and the ↵Miss Islington (bot)2024-08-251-0/+8
| | | | | | | | limit arguments (GH-123286) (#123326) gh-82378: Document the difference between sys.tracebacklimit and the limit arguments (GH-123286) (cherry picked from commit 70bfef52b5734d6cd81c5e8ca9eaf85658916b04) Co-authored-by: CF Bolz-Tereick <cfbolz@gmx.de>
* [3.12] gh-122982: Extend the deprecation period for bool inversion by two ↵Miss Islington (bot)2024-08-251-1/+1
| | | | | | | | years (GH-123306) (#123317) gh-122982: Extend the deprecation period for bool inversion by two years (GH-123306) (cherry picked from commit 249b083ed8b3cfdff30bf578d7f9d3c5e982a4eb) Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
* [3.12] gh-123110: correct note about _Bool in the struct module docs ↵Miss Islington (bot)2024-08-191-3/+3
| | | | | | | | (GH-123111) (#123127) gh-123110: correct note about _Bool in the struct module docs (GH-123111) (cherry picked from commit b0f462d4c808d6fb1d381bba4932acd8309c1f3b) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
* [3.12] fix typo in dis.rst (GH-121612) (#123096)Miss Islington (bot)2024-08-171-1/+1
| | | | | | fix typo in dis.rst (GH-121612) (cherry picked from commit e9287ea426e8e1b930f1c3f0cb949a1416d29090) Co-authored-by: mathysEthical <110499907+mathysEthical@users.noreply.github.com>
* [3.12] gh-122519: Adding socket module shutdown() constants description ↵Miss Islington (bot)2024-08-171-0/+7
| | | | | | | | (GH-122543) (#123094) gh-122519: Adding socket module shutdown() constants description (GH-122543) (cherry picked from commit 8a59deca59aa9452e71bb49e909199fbb41a5de7) Co-authored-by: Damien <81557462+Damien-Chen@users.noreply.github.com>