Commit graph

13389 commits

Author SHA1 Message Date
Miss Islington (bot)
f8e3de8c7d
[3.13] docs: improve venv docs (GH-124540) (#124727)
docs: improve venv docs (GH-124540)

- 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 c976d789a9)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-09-29 17:58:32 -07:00
Miss Islington (bot)
e532760f46
[3.13] Docs: improve generic typing.NamedTuple example (GH-124739) (#124764)
Docs: improve generic `typing.NamedTuple` example (GH-124739)
(cherry picked from commit 76fbee642e)

Co-authored-by: CBerJun <121291537+CBerJun@users.noreply.github.com>
2024-09-29 17:53:13 -07:00
Miss Islington (bot)
2b74cce521
[3.13] gh-90190: Add doc for using singledispatch with precise collection type hints (GH-116544) (#124710)
gh-90190: Add doc for using `singledispatch` with precise collection type hints (GH-116544)
(cherry picked from commit 2357d5ba48)

Co-authored-by: Matt Delengowski <matt.delengowski@gmail.com>
2024-09-27 21:28:30 +00:00
Miss Islington (bot)
c6c3d970ba
[3.13] gh-119004: fix a crash in equality testing between OrderedDict (GH-121329) (#124507)
gh-119004: fix a crash in equality testing between `OrderedDict` (GH-121329)
(cherry picked from commit 38a887dc3e)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-09-27 11:34:48 -07:00
Miss Islington (bot)
4c97ed4682
[3.13] Docs: Update and proofread library/venv.rst (GH-124121) (#124644)
Docs: Update and proofread `library/venv.rst` (GH-124121)
(cherry picked from commit 23e812b84a)

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>
2024-09-27 11:16:02 -07:00
Alex Waygood
0c6ddadbc4
[3.13] Fixup indentation for docs on ModuleSpec attributes (#124681) (#124685)
Fixup indentation for docs on `ModuleSpec` attributes (#124681)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-09-27 17:59:52 +00:00
Miss Islington (bot)
c74679bff7
[3.13] gh-118181: Fix parameter markup in AST docs (GH-124473) (#124600)
gh-118181: Fix parameter markup in AST docs (GH-124473)
(cherry picked from commit 09aebb1fbc)

Co-authored-by: Tomas R <tomas.roun8@gmail.com>
2024-09-26 13:52:37 -07:00
Miss Islington (bot)
c2aaf50780
[3.13] gh-123560: Correct docs for "empty" format type for floats (GH-123561) (#124596)
gh-123560: Correct docs for "empty" format type for floats (GH-123561)
(cherry picked from commit 274d9ab619)

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-09-26 13:52:18 -07:00
Malcolm Smith
9f5b921491
[3.13] gh-123014: Disable pidfd API on older Android versions (GH-124458) (#124543)
gh-123014: Disable pidfd API on older Android versions (#124458)

(cherry picked from commit c58c572a65)
2024-09-26 13:36:12 -07:00
Alex Waygood
9f2e6ca199
[3.13] gh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs (#124480) (#124556) 2024-09-25 17:29:48 -07:00
Miss Islington (bot)
9fba1063a1
[3.13] gh-123223: Adding hyperlink of argument in warnings.catch_warnings: (GH-123231) (#124528)
gh-123223: Adding hyperlink of argument in warnings.catch_warnings: (GH-123231)

* Adding hyperlink of argument

* Modify as reviewer suggested
(cherry picked from commit 828583a785)

Co-authored-by: Damien <81557462+Damien-Chen@users.noreply.github.com>
2024-09-25 17:16:18 -07:00
Miss Islington (bot)
6607c72991
[3.13] gh-123968: fix -f/--float command line option description (GH-124517) (#124523)
gh-123968: fix -f/--float command line option description (GH-124517)

* fix -f/--float command line option description

See gh-123968 gh-124009

* Update Doc/library/random.rst

---------

(cherry picked from commit f8651a2988)

Co-authored-by: Robert Wolff <mahlzahn@posteo.de>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-09-25 17:16:02 -07:00
Miss Islington (bot)
139f47fe5d
[3.13] gh-123445: calendar: Improve descriptions for day and month attributes (GH-123483) (#124500)
gh-123445: calendar: Improve descriptions for day and month attributes (GH-123483)
(cherry picked from commit 8447c933da)

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>
2024-09-25 17:13:14 -07:00
Miss Islington (bot)
5b7d4cef82
[3.13] Doc: Improve documentation for the `path argument in shutil.which()` (GH-124494) (#124497)
Doc: Improve documentation for the ``path`` argument in ``shutil.which()`` (GH-124494)
(cherry picked from commit 0d38409f42)

Co-authored-by: Tom Most <twm@freecog.net>
2024-09-25 17:12:48 -07:00
Miss Islington (bot)
8c0c3443f3
[3.13] gh-124120: Document Annotated.__origin__ (GH-124125) (#124416)
gh-124120: Document `Annotated.__origin__` (GH-124125)
(cherry picked from commit faef3fa653)

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>
2024-09-24 11:34:21 -07:00
Miss Islington (bot)
e5105ccbe1
[3.13] gh-65169: Clarify prog default in argparse (GH-31602) (#124430)
gh-65169: Clarify prog default in argparse (GH-31602)
(cherry picked from commit e69ff34e81)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2024-09-24 11:26:32 -07:00
Miss Islington (bot)
4ab684d694
[3.13] Remove excessive backticks in logging doc (GH-123813) (#123816)
Remove excessive backticks in logging doc (GH-123813)
(cherry picked from commit 93050e4614)

Co-authored-by: Wei-Hsiang (Matt) Wang <mattwang44@gmail.com>
2024-09-24 11:21:29 -07:00
Miss Islington (bot)
c184b0680a
[3.13] gh-123789: secrets.randbits returns only non-negative int (GH-123801) (#123830)
gh-123789: `secrets.randbits` returns only non-negative int (GH-123801)
(cherry picked from commit beee91cdcc)

Co-authored-by: Wulian <1055917385@qq.com>
2024-09-24 11:21:10 -07:00
Miss Islington (bot)
4163260c57
[3.13] gh-123834: Add symtable to the list of modules with a CLI (GH-123835) (#123862)
gh-123834: Add `symtable` to the list of modules with a CLI (GH-123835)
(cherry picked from commit 32bc2d6141)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-09-24 11:20:48 -07:00
Miss Islington (bot)
5be6c4e3c7
[3.13] Mention curl in contextvars docs (GH-123838) (#123868)
Mention `curl` in `contextvars` docs (GH-123838)
(cherry picked from commit b950831c94)

Co-authored-by: sobolevn <mail@sobolevn.me>
2024-09-24 11:17:51 -07:00
Miss Islington (bot)
857a161bb8
[3.13] gh-123905: Update TOML description to include version number (GH-123906) (#123908)
gh-123905: Update TOML description to include version number (GH-123906)

Update TOML description to include version number

There is some movement, currently blocked, that would update the TOML spec to 1.1.0; this would include breaking changes to what characters are allowed. Thus, it is worthwhile for the library page to be clear which version is implemented here.

(cherry picked from commit 1b29f4144c)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Paul Hoffman <phoffman@proper.com>
2024-09-24 11:15:30 -07:00
Miss Islington (bot)
951c7dba79
[3.13] gh-108951: Document how to terminate an asyncio.TaskGroup (GH-123837) (#123956)
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 ef05801ba0)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-09-24 11:11:31 -07:00
Miss Islington (bot)
b4b182a84d
[3.13] GH-87358: Add clarification about nargs and default argparse behaviour (GH-124094) (#124440)
GH-87358: Add clarification about nargs and default argparse behaviour (GH-124094)
(cherry picked from commit 20ccda000b)

Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>
2024-09-24 11:08:02 -07:00
Miss Islington (bot)
e9b00cc788
[3.13] gh-121607: Edited source file import recipe to make it more clear (GH-121519) (#124080)
gh-121607: Edited source file import recipe to make it more clear (GH-121519)
(cherry picked from commit 38809171b8)

Co-authored-by: Chris Barker <Chris.Barker@noaa.gov>
Co-authored-by: Brett Cannon <brett@python.org>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2024-09-24 01:52:45 +00:00
Miss Islington (bot)
6867604781
[3.13] GH-103484: Fix permanently redirects reported by linkcheck (GH-124144) (#124151)
GH-103484: Fix permanently redirects reported by linkcheck (GH-124144)

Fix redirects reported by linkcheck, update docs conf.py checks.
(cherry picked from commit 0a32c6959c)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-09-24 00:43:04 +00:00
Miss Islington (bot)
5fa7f5a734
[3.13] gh-118577: Clarify that inspect.BoundArguments prefers to put values in args (GH-119936) (#124005)
gh-118577: Clarify that inspect.BoundArguments prefers to put values in args (GH-119936)
(cherry picked from commit 8e99495701)

Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
2024-09-23 17:35:29 -07:00
Miss Islington (bot)
9a60a9ddaf
[3.13] gh-116622: Complete Android documentation (GH-124259) (#124395)
gh-116622: Complete Android documentation (GH-124259)
(cherry picked from commit e80dd3035f)

Co-authored-by: Malcolm Smith <smith@chaquo.com>
Co-authored-by: Russell Keith-Magee <russell@keith-magee.com>
Co-authored-by: T. Wouters <thomas@python.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-09-24 00:13:45 +00:00
Miss Islington (bot)
74edb7d9bc
[3.13] GH-103484: Fix broken links reported by linkcheck (GH-124169) (#124179)
GH-103484: Fix broken links reported by linkcheck (GH-124169)
(cherry picked from commit ab80c6b402)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-09-23 16:34:48 -07:00
Miss Islington (bot)
848a21007b
[3.13] Fix typo in XMLParser doc (GH-124129) (#124280)
Fix typo in XMLParser doc (GH-124129)
(cherry picked from commit 622368d99c)

Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
2024-09-23 15:53:10 -07:00
Miss Islington (bot)
5760330c7a
[3.13] gh-124130: Notes on empty string corner case of category \B (GH-124133) (#124328)
gh-124130: Notes on empty string corner case of category `\B` (GH-124133)
(cherry picked from commit d3e79d75d1)

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>
2024-09-23 15:50:54 -07:00
Miss Islington (bot)
a052faf58e
[3.13] GH-79714: Add mention of stderr for clarity to ArgumentParser.exit() (GH-123932) (#124331)
GH-79714: Add mention of stderr for clarity to ArgumentParser.exit() (GH-123932)
(cherry picked from commit 5f5c0b9c23)

Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>
2024-09-23 15:50:24 -07:00
Miss Islington (bot)
8d5911ef6b
[3.13] Use pep role instead of url (GH-121611) (#124172)
Use pep role instead of url (GH-121611)
(cherry picked from commit 33eeccf6d4)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-09-23 11:39:16 -07:00
Miss Islington (bot)
bbec2ea88f
[3.13] Fix "The Matrix" movie release year in typing.rst (GH-123965) (#123966)
Fix "The Matrix" movie release year in `typing.rst` (GH-123965)
(cherry picked from commit 3bd942f106)

Co-authored-by: sobolevn <mail@sobolevn.me>
2024-09-23 11:34:44 -07:00
Adam Turner
86f30dd539
[3.13] GH-109975: Copyedit 3.13 What's New: C API (GH-124313) (#124334)
* [3.13] GH-109975: Copyedit 3.13 What's New: C API (GH-124313)
(cherry picked from commit 9d0a75269c)

* gh-118915: Add/fix docs entries for some new 3.13 C API (GH-124134)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2024-09-23 11:14:13 -07:00
Miss Islington (bot)
6d482ff296
[3.13] Normalize cdecl formatting as found elsewhere on ctypes.rst (GH-121379) (#124056)
Normalize cdecl formatting as found elsewhere on ctypes.rst (GH-121379)
(cherry picked from commit bbb36c0934)

Co-authored-by: utkonos <utkonos@users.noreply.github.com>
2024-09-23 10:53:07 -07:00
Miss Islington (bot)
e62cb77c25
[3.13] gh-123523: Rework typing documentation for generators and coroutines, and link to it from collections.abc docs (GH-123544) (#123790)
gh-123523: Rework typing documentation for generators and coroutines, and link to it from `collections.abc` docs (GH-123544)
(cherry picked from commit 56e4a417ce)

Co-authored-by: Stanislav Terliakov <50529348+sterliakov@users.noreply.github.com>
2024-09-06 22:56:37 +02:00
Miss Islington (bot)
c46ad20d41
[3.13] gh-123207: Clarify the documentation for the mro lookup for super() (GH-123417) (#123732)
(cherry picked from commit 327463aef1)

Co-authored-by: Pieter Eendebak <pieter.eendebak@gmail.com>
2024-09-06 15:45:22 +02:00
Miss Islington (bot)
37e1f8d2a0
[3.13] gh-103066: Add links and help in site.py constants (GH-103777) (#123762)
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>
2024-09-06 11:08:29 +03:00
Miss Islington (bot)
ff9ece98e2
[3.13] gh-85453: Improve instance attributes mark up on datetime.rst (GH-123655) (#123740)
Co-authored-by: edson duarte <eduarte.uatach@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-09-05 18:16:48 +00:00
Miss Islington (bot)
3765181359
[3.13] gh-123392: Clarify wording regarding parameters that are functions to be called (GH-123394) (GH-123664)
(cherry picked from commit c08ede2714)

Co-authored-by: ryan-duve <ryan-duve@users.noreply.github.com>
2024-09-05 12:49:51 +02:00
Miss Islington (bot)
3b37658646
[3.13] gh-118508: Clarify which characters are matched by \s (GH-119155) (#123670)
gh-118508: Clarify which characters are matched by `\s` (GH-119155)

Clarify re syntax
(cherry picked from commit 22fdb8cf89)

Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
2024-09-04 15:36:14 -07:00
Wei-Hsiang (Matt) Wang
05dcc81601
[3.13] gh-123517: Remove unnecessary :meth: parentheses (gh-123518) (GH-123577) 2024-09-02 16:00:04 +02:00
Miss Islington (bot)
ec92c8a018
[3.13] gh-123570: Add link to weakref.ref from weakref_slot docs in dataclasses (GH-123571) (#123594)
gh-123570: Add link to `weakref.ref` from `weakref_slot` docs in `dataclasses` (GH-123571)
(cherry picked from commit c3ed775899)

Co-authored-by: sobolevn <mail@sobolevn.me>
2024-09-02 13:20:35 +02:00
Wulian
5c408e333d
[3.13] Fix typos in docs and what's new (#123451) 2024-09-02 13:15:02 +02:00
Miss Islington (bot)
aca65112fe
[3.13] GH-117759: Document incremental GC (GH-123266) (#123395)
GH-117759: Document incremental GC (GH-123266)

* Update what's new

* Update gc module docs and fix inconsistency in gc.get_objects
(cherry picked from commit f49a91648a)

Co-authored-by: Mark Shannon <mark@hotpy.org>
2024-09-02 13:12:16 +02:00
Miss Islington (bot)
d9e4c4b61c
[3.13] gh-123213: Fixed xml.etree.ElementTree.Element.extend and assignment to no longer hide exceptions (GH-123214) (#123257)
gh-123213: Fixed xml.etree.ElementTree.Element.extend and assignment to no longer hide exceptions (GH-123214)
(cherry picked from commit 90b6d0e0f8)

Co-authored-by: Bar Harel <bharel@barharel.com>
2024-09-02 13:10:09 +02:00
Alex Waygood
3455d8560a
[3.13] Fix typos in docs, error messages and comments (#122502) (#122606)
Fix typos in docs, error messages and comments (#122502)

(cherry-picked from commit 46f5a4f9e1)

Signed-off-by: jianghuyiyuan <shuangcui@live.com>
Co-authored-by: jianghuyiyuan <shuangcui@live.com>
2024-09-02 12:44:42 +02:00
Miss Islington (bot)
cfdf376e2a
[3.13] gh-91126: Docs and tests for slotted dataclasses with __init_subclass__ (GH-123342) (#123568)
gh-91126: Docs and tests for slotted dataclasses with `__init_subclass__` (GH-123342)
(cherry picked from commit 75e72822a3)

Co-authored-by: sobolevn <mail@sobolevn.me>
2024-09-01 18:19:56 +03:00
Miss Islington (bot)
b0a50a69cf
[3.13] gh-123550: Fix code snippet of BUILD_TUPLE in dis docs (GH-123551) (#123555) 2024-09-01 08:38:20 +01:00
Miss Islington (bot)
dc06b3d01e
[3.13] gh-123494: Improve documentation for `webbrowser` return types (GH-123495) (#123548)
gh-123494: Improve documentation for ``webbrowser`` return types (GH-123495)

Document the return value for ``webbrowser.open*()``.
(cherry picked from commit 0b6acfee04)

Co-authored-by: Aarni Koskela <akx@iki.fi>
2024-09-01 05:41:10 +00:00