Commit graph

14435 commits

Author SHA1 Message Date
Miss Islington (bot)
bc8497b77a
[3.14] Mention _Float16 (type from Annex H of the C23) in the struct docs (GH-146243) (#146529)
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2026-03-27 17:44:27 +00:00
Miss Islington (bot)
de54353235
[3.14] gh-144837: Improve documentation for more collection methods (GH-144841) (GH-146483)
Use uniform standard signature syntax in the tutorial and in
the array and collections modules documentation.
(cherry picked from commit 17070f41d4)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2026-03-26 19:55:25 +00:00
Miss Islington (bot)
25714b3c82
[3.14] gh-146318: Document that signal.SIGSTOP is Unix-only (GH-146319) (#146468)
gh-146318: Document that signal.SIGSTOP is Unix-only (GH-146319)
(cherry picked from commit e44993a665)

Co-authored-by: Jonathan Dung <jonathandung@yahoo.com>
2026-03-26 16:49:43 +01:00
Miss Islington (bot)
ac2fff4c0e
[3.14] gh-140196: Added constructor behavior changes in ast.rst for python 3.13 (GH-140243) (GH-146351)
(cherry picked from commit fae5761a76)

Co-authored-by: Parman Mohammadalizadeh <prmma23@gmail.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2026-03-24 02:37:09 +01:00
dr-carlos
dd4ea46917
[3.14] gh-141732: Fix ExceptionGroup repr changing when original exception sequence is mutated (GH-141736) (GH-144445)
Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2026-03-23 23:31:32 +01:00
Miss Islington (bot)
1b2f0bd54c
[3.14] gh-136672: Docs: Move parts of Enum HOWTO to API Docs (GH-139176) (GH-144802)
To avoid duplicate content in the Enum HOWTO and
API documentation which is not automatically synced,
the section about supported __dunder__ and _sunder
names is moved from HOWTO to API docs.

See also https://github.com/python/cpython/pull/136791
(cherry picked from commit 629a363ddd)

Co-authored-by: Rafael Weingartner-Ortner <38643099+RafaelWO@users.noreply.github.com>
2026-03-23 21:21:41 +01:00
Miss Islington (bot)
f883bbd433
[3.14] gh-108907: ctypes: Document _type_ codes (GH-145837) (GH-146328)
gh-108907: ctypes: Document _type_ codes (GH-145837)

Add `_SimpleCData._type_` docs.

Add type codes to the summary table.

Cross-link `struct`, `array`, and `ctypes`; throw in `numpy` too.
(Anyone wanting to add a code should be aware of those.)

Add `py_object`, and `VARIANT_BOOL` for completeness.
(cherry picked from commit 1114d7f7f8)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2026-03-23 14:07:24 +01:00
Miss Islington (bot)
d65e8d9094
[3.14] Docs: replace all datetime imports with import datetime as dt (GH-145640) (#146258)
Docs: replace all `datetime` imports with `import datetime as dt` (GH-145640)
(cherry picked from commit 83360b5869)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2026-03-21 20:19:07 +02:00
Miss Islington (bot)
f2c70247fb
[3.14] gh-138234: clarify returncode behavior for subprocesses created with shell=True (GH-138536) (#146254)
gh-138234: clarify returncode behavior for subprocesses created with `shell=True` (GH-138536)
(cherry picked from commit 8a531f89df)

Co-authored-by: andreuu-tsai <32549555+andreuu-tsai@users.noreply.github.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2026-03-21 12:38:34 +00:00
Miss Islington (bot)
d6e0066920
[3.14] GH-100108: Add async generators best practices section (GH-141885) (#146252)
GH-100108: Add async generators best practices section (GH-141885)
(cherry picked from commit 897fa231a7)

Co-authored-by: Sergey Miryanov <sergey.miryanov@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2026-03-21 12:05:06 +00:00
Miss Islington (bot)
8b447fb56c
[3.14] gh-91279: Note SOURCE_DATE_EPOCH support in ZipFile.writestr() doc (GH-139396) (#146222)
gh-91279: Note `SOURCE_DATE_EPOCH` support in `ZipFile.writestr()` doc (GH-139396)
(cherry picked from commit 5ad738f8fb)

Co-authored-by: Wulian233 <1055917385@qq.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2026-03-20 16:20:39 +00:00
Miss Islington (bot)
f20a637644
[3.14] gh-142518: Add thread safety notes for the buffer protocol (GH-145911) (#146106)
(cherry picked from commit 847f83ef1c)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
2026-03-18 14:28:52 +01:00
Miss Islington (bot)
e050831bd9
[3.14] Docs: remove unmatched parenthesis for asyncio.TaskGroup note (GH-146035) (#146037)
Docs: remove unmatched parenthesis for `asyncio.TaskGroup` note (GH-146035)
(cherry picked from commit 4e96282ee4)

Co-authored-by: trag1c <dev@jakubr.me>
2026-03-16 21:59:31 +01:00
Miss Islington (bot)
64e2acbc8e
[3.14] gh-142518: Document thread-safety guarantees of bytearray objects (GH-145226) (#145982)
(cherry picked from commit 2f4e4ec2e7)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
2026-03-15 16:03:32 +01:00
Miss Islington (bot)
5fa025aebe
[3.14] gh-69223: Document that add_argument() returns an Action object (GH-145538) (#145595)
Co-authored-by: Andrew Barnes <bortstheboat@gmail.com>
2026-03-15 14:08:21 +00:00
Miss Islington (bot)
ef757268e0
[3.14] Docs: fix missing period in Doc/library/stdtypes.rst (GH-145935) (#145936)
Docs: fix missing period in `Doc/library/stdtypes.rst` (GH-145935)
(cherry picked from commit 51e8acf8de)

Co-authored-by: Connor Gibson <connor@nextdoortech.net>
2026-03-14 09:26:32 +00:00
Miss Islington (bot)
7e4dc65ad8
[3.14] gh-142518: Document thread-safety guarantees of set objects (GH-145225) (#145915)
(cherry picked from commit 79b91e7c50)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
2026-03-13 13:59:17 +00:00
Miss Islington (bot)
f9589cb1b2
[3.14] gh-145254: Add thread safety annotation in docs (GH-145255) (#145862)
Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
2026-03-12 15:36:58 +02:00
Miss Islington (bot)
f688a4bafd
[3.14] gh-99875: Document rounding mode for old-style formatting (GH-126382) (#145811)
gh-99875: Document rounding mode for old-style formatting (GH-126382)
(cherry picked from commit ce1abaf9b8)

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2026-03-11 13:31:44 +00:00
Miss Islington (bot)
6080c86609
[3.14] Warn that overriding __builtins__ for eval is not a security mechanism (GH-145773) (GH-145808)
(cherry picked from commit eb9ae65e5b)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2026-03-11 13:43:19 +01:00
Miss Islington (bot)
f4d53321a7
[3.14] gh-101100: Fix sphinx reference warnings around I/O (GH-139592) (#145794)
Co-authored-by: Cody Maloney <cmaloney@users.noreply.github.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2026-03-11 08:08:09 +00:00
Miss Islington (bot)
387abcce91
[3.14] gh-106318: Add examples for str.isspace() docs (GH-145399) (#145752)
Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2026-03-10 14:25:46 +00:00
Hugo van Kemenade
ed2df30f40
[3.14] gh-140715: Improve class reference links on datetime.rst (GH-123980) (#145388)
Co-authored-by: edson duarte <eduarte.uatach@gmail.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2026-03-10 13:38:20 +02:00
Miss Islington (bot)
38440549db
[3.14] gh-141617: clarify concurrent.futures.ThreadPoolExecutor deadlock example (GH-141620) (#145686)
gh-141617: clarify `concurrent.futures.ThreadPoolExecutor` deadlock example (GH-141620)

---------
(cherry picked from commit 171133aa84)

Co-authored-by: Yashraj <yashrajpala8@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2026-03-09 16:36:00 +00:00
Miss Islington (bot)
778ff23689
[3.14] gh-78773: Improve ctypes dynamic library loading docs (GH-145313) (GH-145674)
(cherry picked from commit d64f83d07b)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2026-03-09 15:52:16 +01:00
Miss Islington (bot)
5f25707ad8
[3.14] Remove typo in `functools.lru_cache` docs (GH-140278) (#145628)
Co-authored-by: Brandon Hubacher <brandon.hubacher@gmail.com>
2026-03-07 17:14:45 +00:00
Miss Islington (bot)
3a7c897518
[3.14] Docs: import datetime as dt in examples (GH-145315) (#145583)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2026-03-06 13:49:40 +02:00
Miss Islington (bot)
da3fea361e
[3.14] Fix incorrect statement about argparse.ArgumentParser.add_argument() (GH-145479) (#145485)
Fix incorrect statement about argparse.ArgumentParser.add_argument() (GH-145479)
(cherry picked from commit dc12d1999b)

Co-authored-by: Justin Kunimune <justinkunimune@gmail.com>
Co-authored-by: Savannah Ostrowski <savannah@python.org>
2026-03-03 21:47:39 +00:00
Miss Islington (bot)
9a63576b10
[3.14] GH-145450: Document missing wave.Wave_write getter methods (GH-145451) (GH-145466)
(cherry picked from commit db41717cd5)

Co-authored-by: Michiel W. Beijen <mb@x14.nl>
2026-03-03 12:50:45 +00:00
Miss Islington (bot)
d8f0ffebef
[3.14] gh-106318: Fix incorrectly rendered code block in str.isalnum() docs (GH-144718) (GH-144730)
(cherry picked from commit f912c835b9)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2026-03-03 13:12:36 +01:00
Miss Islington (bot)
3c19c88fa9
[3.14] Hide "object" prefix on dunders in contextlib docs & selectivly link some more (GH-145436) (#145443)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2026-03-02 21:18:12 +00:00
Miss Islington (bot)
4152bbb773
[3.14] gh-145269: simplify bisect.bisect doc example (GH-145270) (#145367)
gh-145269: simplify bisect.bisect doc example (GH-145270)



---------
(cherry picked from commit fdb4b3527f)

Co-authored-by: Nathan Goldbaum <nathan.goldbaum@gmail.com>
Co-authored-by: Pieter Eendebak <pieter.eendebak@gmail.com>
2026-02-28 19:28:14 +00:00
Miss Islington (bot)
856fdc6f6b
[3.14] gh-144190: Clarify get_type_hints() instance behavior in docs (GH-144831) (#145258)
Co-authored-by: Rajhans Jadhao <rajhans.jadhao@gmail.com>
2026-02-26 13:53:16 +00:00
Miss Islington (bot)
ea628136c0
[3.14] gh-106318: Add examples for str.rjust() method (GH-143890) (#145257)
Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2026-02-26 13:48:04 +00:00
Miss Islington (bot)
310455ca51
[3.14] gh-142518: Move thread safety sections into a new page (GH-144716) (#145223)
- Create a new page for thread safety notes for built-in types
- Move thread safety notes for `list` into the new page
- Move thread safety notes for `dict` into the new page
---------
(cherry picked from commit 017ccd3bf4)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2026-02-25 16:57:32 +01:00
Savannah Ostrowski
8b34bcc6a7
[3.14] Update argparse suggest_on_error code snippet in docs (GH-144985) (#145151)
Update argparse `suggest_on_error` code snippet in docs (#144985)

(cherry picked from commit 6194a552f2)
2026-02-23 17:35:04 +00:00
Miss Islington (bot)
fece40f7bc
[3.14] gh-144694: Fix re.Match.group() doc claiming [1..99] range limit (GH-144696) (#145065)
gh-144694: Fix re.Match.group() doc claiming [1..99] range limit (GH-144696)

The documentation incorrectly stated that numeric group arguments
must be in the range [1..99]. This limit was removed in Python 3.5
(bpo-22437). Replace with "a positive integer" since the next
sentence already documents the IndexError for out-of-range values.
(cherry picked from commit 85021bc247)

Co-authored-by: Mohsin Mehmood <55545648+mohsinm-dev@users.noreply.github.com>
2026-02-21 05:42:08 +00:00
Miss Islington (bot)
e69501969b
[3.14] Simplify summary tables in the itertools docs (gh-145050) (gh-145051) 2026-02-20 12:52:26 -06:00
Miss Islington (bot)
24b53097d9
[3.14] Remove unused :platform: in module's docs (GH-144988) (GH-144994)
Remove unused :platform: in module's docs (GH-144988)

It has not been outputted since Sphinx 1.1.
(cherry picked from commit 20caf1c084)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2026-02-19 11:51:18 +00:00
Miss Islington (bot)
2ae7c2fadf
[3.14] gh-141984: Reword and reorganize the first part of Atoms docs (GH-144117) (GH-144959)
(cherry picked from commit 112d8ac972)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2026-02-18 17:59:17 +01:00
Stan Ulbrych
8fa0f91e6f
[3.14] Datetime: Tidy up docs (GH-144720) (GH-144956)
(cherry picked from commit c6a142f947)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2026-02-18 15:14:44 +01:00
Stan Ulbrych
b1accd51d8
[3.14] Fix typos and grammar errors across documentation (GH-144709) (#144801)
(cherry picked from commit 3718f4be60)

Co-authored-by: Ronald Eddy Jr <ronald_eddy@yahoo.com>
2026-02-17 12:53:42 +00:00
Miss Islington (bot)
fdbdd9fb5c
[3.14] gh-144706: Warn against using synchronization primitives within signal handlers (GH-144736) (GH-144767)
gh-144706: Warn against using synchronization primitives within signal handlers (GH-144736)
(cherry picked from commit 945bf8ce1b)

Co-authored-by: Robsdedude <dev@rouvenbauer.de>
2026-02-12 23:21:17 +00:00
Miss Islington (bot)
7f5a3acded
[3.14] gh-57095: Add note about input splitting in datetime.*.strptime (GH-131049) (GH-144735)
(cherry picked from commit 2e3e76e5cd)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2026-02-12 11:44:32 +01:00
Miss Islington (bot)
3aef49417e
[3.14] gh-142518: Document thread-safety guarantees of dict operations (GH-144184) (#144708)
* Address feedback; move thread safety section below see-also
* Address feedback - don't mention equality comparison only
* Change admonition to rubric; cross-reference glossary

---------
(cherry picked from commit 35dc547ab5)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2026-02-11 14:39:40 +01:00
Miss Islington (bot)
8c4ce4be26
[3.14] gh-142518: Define lock-free and per-object lock (GH-144548) (#144704)
gh-142518: Define lock-free and per-object lock (GH-144548)

- Add definitions of lock-free and per-object lock to the glossary
- Cross-reference these from list thread safety notes
- Change admonition to rubric
(cherry picked from commit 12dbae4c02)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
2026-02-11 14:16:55 +01:00
Ned Batchelder
78fa4705d8
[3.14] Docs: remove links of modules to themselves (GH-144695) (#144705) 2026-02-11 08:09:56 -05:00
Miss Islington (bot)
a77dde441e
[3.14] gh-106318: Improve str.rstrip() method doc (GH-143893) (#144699)
gh-106318: Improve str.rstrip() method doc (GH-143893)
(cherry picked from commit 936d60dbe1)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2026-02-11 08:48:22 +00:00
Miss Islington (bot)
bcbeff52be
[3.14] Clarify the docs for args in asyncio callbacks (GH-143873) (#144663)
Clarify the docs for `args` in asyncio callbacks (GH-143873)
(cherry picked from commit 40a82abe93)

Co-authored-by: Aarni Koskela <akx@iki.fi>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2026-02-10 13:16:26 +00:00
Miss Islington (bot)
27baa1cd5d
[3.14] gh-106318: Add examples for str.partition() method (GH-142823) (#144611)
gh-106318: Add examples for str.partition() method (GH-142823)
(cherry picked from commit 432ddd99e2)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2026-02-08 22:17:46 +00:00