Commit graph

27205 commits

Author SHA1 Message Date
Miss Islington (bot)
72410a3ecf
[3.12] gh-67641: Clarify documentation on bytes vs text with non-seeking tarfile stream (GH-31610) (GH-113519)
(cherry picked from commit 0651936ae2)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2023-12-27 17:32:10 +00:00
Hugo van Kemenade
6177a852c4
[3.12] gh-101100: Fix Sphinx warnings in library/cmd.rst (GH-113502) (#113511)
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-27 10:27:13 +00:00
Hugo van Kemenade
11fd024286
[3.12] gh-101100: Fix Sphinx warnings in library/calendar.rst (GH-113500) (#113509) 2023-12-27 09:45:32 +00:00
Miss Islington (bot)
356f59677e
[3.12] gh-101100: Fix Sphinx warnings in library/bisect.rst (GH-113496) (#113504)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-26 14:54:02 -07:00
Miss Islington (bot)
2f5bfc7e66
[3.12] gh-101100: Fix Sphinx warnings in howto/isolating-extensions.rst (GH-113493) (#113497)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-26 19:46:40 +00:00
Miss Islington (bot)
f445aeac26
[3.12] Docs: make htmllive: open browser when ready (GH-113288) (#113484)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-26 12:08:43 +00:00
Miss Islington (bot)
8a95500367
[3.12] Misc minor improvements to the itertools recipes (gh-113477) (gh-113478) 2023-12-25 22:32:05 +00:00
Miss Islington (bot)
c0e58168e2
[3.12] [doc] Make subprocess.wait documentation more precise (GH-98700) (GH-112153)
An active loop is only used when the `timeout` parameter is used on
POSIX.

When no timeout is used, the code calls `os.waitpid` internally (which puts
the process on a sleep status). On Windows, the internal Windows API
call accepts a timeout parameter, so that is delegated to the OS.
(cherry picked from commit 81ab0e8a4a)

Co-authored-by: Luis Pedro Coelho <luis@luispedro.org>
2023-12-25 20:27:06 +02:00
Miss Islington (bot)
78ccb41c56
[3.12] docs: specify that PyBytes_AsStringAndSize returns 0 on success (GH-110888) (GH-111690)
(cherry picked from commit 9f33ede127)

Co-authored-by: lefp <70862148+lefp@users.noreply.github.com>
2023-12-25 20:24:22 +02:00
Miss Islington (bot)
4882d508be
[3.12] gh-74573: document that ndbm can silently corrupt databases on macOS (GH-113354) (#113431)
gh-74573: document that ndbm can silently corrupt databases on macOS (GH-113354)

* gh-74573: document that ndbm can silently corrupt databases on macOS

The system ndbm implementation on macOS has an undocumented limitation
on the size of values and can silently corrupt database files when those
are exceeded.

(cherry picked from commit 593b4d81d2)

Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2023-12-23 13:49:33 +01:00
Miss Islington (bot)
fee2bc15f9
[3.12] gh-112925: Fix error in example of datetime.time.fromisoformat and add doctest marker (GH-112931) (GH-113427)
(cherry picked from commit bdc8d667ab)

Co-authored-by: F-park <52167622+F-park@users.noreply.github.com>
2023-12-23 10:50:00 +00:00
Miss Islington (bot)
08d3b5dd30
[3.12] gh-113313: Note that slice support is not required for all sequences. (gh-113377) (gh-113382) 2023-12-21 22:00:52 +00:00
Miss Islington (bot)
8836c2d91a
[3.12] Docs: OpenSSL wording ambiguity (GH-113296) (#113348)
Co-authored-by: Jan Brasna <1784648+janbrasna@users.noreply.github.com>
2023-12-21 07:56:06 +00:00
Miss Islington (bot)
b01caf1d9d
[3.12] gh-113255: Clarify docs for typing.reveal_type (GH-113286) (#113323)
gh-113255: Clarify docs for `typing.reveal_type` (GH-113286)
(cherry picked from commit 11ee912327)

Co-authored-by: Kir <note351@hotmail.com>
Co-authored-by: AlexWaygood <alex.waygood@gmail.com>
2023-12-20 17:36:45 +00:00
Miss Islington (bot)
44101e9cd3
[3.12] Fix typo in datamodel docs (GH-113314) (#113316)
Fix typo in datamodel docs (GH-113314)
(cherry picked from commit 5a7cc667f8)

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2023-12-20 12:05:33 +00:00
Miss Islington (bot)
68743e4473
[3.12] Fix typo in collections.abc docs example (GH-113310) (#113311)
Fix typo in collections.abc docs example (GH-113310)

Calling the instance reference arg for the __next__ method, "next", seems misleading as it would normally just be "self"
(cherry picked from commit 22b8945d76)

Co-authored-by: David Greaves <david@dgreaves.com>
2023-12-20 09:57:48 +00:00
Hugo van Kemenade
72bbd88876
[3.12] gh-101100: Fix Sphinx warnings in library/ast.rst (GH-113289) (#113290) 2023-12-19 18:12:30 +02:00
Miss Islington (bot)
077cb7cae6
[3.12] gh-113234: tomllib docs: reorder conversion table & add remaining types (GH-113236) (GH-113283)
gh-113234: tomllib docs: reorder conversion table & add remaining types (GH-113236)
(cherry picked from commit 76d757b38b)

Co-authored-by: ryan-duve <ryan-duve@users.noreply.github.com>
2023-12-19 10:35:40 +00:00
Miss Islington (bot)
ca5a5231d3
[3.12] gh-113208: Mention namespace packages don't require __init__.py (GH-113209) (#113276)
Co-authored-by: Unique-Usman <86585626+Unique-Usman@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-12-19 08:46:13 +00:00
Hugo van Kemenade
e23657f0f2
[3.12] gh-101100: Fix Sphinx warnings in library/tarfile.rst (GH-113237) (#113244) 2023-12-18 07:11:35 +00:00
Miss Islington (bot)
38a41820ee
[3.12] Docs: Add label to grammar spec for linking from PEPs (GH-113235) (#113239)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-17 19:30:10 +00:00
Miss Islington (bot)
48e1558c23
[3.12] gh-112890: unittest Test Discovery page updated "unittest dropped the namspace packages support" (GH-113195) (GH-113228)
(cherry picked from commit 21d52995ea)

Co-authored-by: Taylor Packard <3.t.packard@gmail.com>
2023-12-17 11:20:46 +00:00
Miss Islington (bot)
3bfe2b6c2a
[3.12] gh-105912: document gotcha with using os.fork on macOS (GH-112871) (#113133)
gh-105912: document gotcha with using os.fork on macOS (GH-112871)

* gh-105912: document gotcha with using os.fork on macOS

Using ``fork(2)`` on macOS when also using higher-level
system APIs in the parent proces can crash on macOS because
those system APIs are not written to handle this usage
pattern.

There's nothing we can do about this other than documenting
the problem.

(cherry picked from commit 22511f77c2)

Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2023-12-16 10:12:10 +01:00
Miss Islington (bot)
37712aced6
[3.12] gh-113046: Revise csv.reader doc (GH-113207) (#113210)
Clarify nature of csvfile.
(cherry picked from commit 84df3172ef)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-12-16 08:19:01 +00:00
Miss Islington (bot)
d77d62ab79
[3.12] Add reshape() recipe to demonstrate a use case for batched() and chained.from_iterable() (gh-113198) (gh-113201) 2023-12-16 00:09:49 +00:00
Miss Islington (bot)
b9c5ffe6e7
[3.12] Use match/case in grouper() recipe (gh-113059) (gh-113197) 2023-12-15 22:39:11 +00:00
Miss Islington (bot)
85ee49c434
[3.12] Minor stylistic edit to the grouper recipe (gh-112759) (gh-113196) 2023-12-15 16:32:32 -06:00
Miss Islington (bot)
9c32d0267f
[3.12] gh-110746: Improve markup in `tkinter.ttk.rst` (GH-111236) (#113193)
gh-110746: Improve markup in ``tkinter.ttk.rst`` (GH-111236)

* gh-110746: Improve markup in tkinter.ttk.rst

* gh-110746: Improve markup in tkinter.ttk.rst

* 📜🤖 Added by blurb_it.

---------

(cherry picked from commit 00d2b6d1fc)

Co-authored-by: Akshat Khandelwal <35228810+akshatgokul@users.noreply.github.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-12-15 22:03:51 +01:00
Miss Islington (bot)
00324a77da
[3.12] gh-101100: Fix various Sphinx warnings for dunder references in the library/ directory (GH-113163) (#113183)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-15 17:22:07 +00:00
Hugo van Kemenade
e3396b2995
[3.12] gh-101100: Fix Sphinx nitpicks in library/numbers.rst (GH-113162) (#113182)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-15 17:21:09 +00:00
Miss Islington (bot)
6259dfa945
[3.12] gh-101100: Fix Sphinx nitpicks in library/rlcompleter.rst (GH-113125) (#113158)
gh-101100: Fix Sphinx nitpicks in `library/rlcompleter.rst` (GH-113125)
(cherry picked from commit 7bb00f053e)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-15 09:04:31 +00:00
Miss Islington (bot)
614691a7e7
[3.12] Optimize unique_justseen() recipe for a common case. (gh-113147) (gh-113150) 2023-12-14 23:34:00 +00:00
Hugo van Kemenade
eda168f99e
[3.12] gh-101100: Cleanup mailbox docs (GH-113124) (#113144)
(cherry picked from commit 25061f5c98)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-14 21:26:26 +00:00
Hugo van Kemenade
2b0853973f
[3.12] gh-101100: Fix Sphinx warnings in whatsnew/2.3.rst (GH-112373) (#113142)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-14 14:09:46 -07:00
Miss Islington (bot)
b4eeb97f1b
[3.12] Remove itertool recipe with low pedagogical value (gh-113138) (gh-113140) 2023-12-14 20:42:36 +00:00
Miss Islington (bot)
15114517dd
[3.12] gh-101100: Fix Sphinx nitpicks in library/collections.abc.rst (GH-113116) (#113136)
gh-101100: Fix Sphinx nitpicks in `library/collections.abc.rst` (GH-113116)
(cherry picked from commit 006355b2a9)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-14 19:32:30 +00:00
Miss Islington (bot)
6b295722aa
[3.12] Add recipe for totient() to demonstrate unique_justseen() and factor(). (gh-113131) (gh-113134) 2023-12-14 19:24:15 +00:00
Miss Islington (bot)
a157881dbc
[3.12] gh-113113: doc: use less ambiguously named variable (gh-113114) (gh-113122) 2023-12-14 16:25:07 +00:00
Miss Islington (bot)
c6c559a669
[3.12] gh-101100: Fix Sphinx nitpicks in library/traceback.rst (GH-113106) (#113111)
gh-101100: Fix Sphinx nitpicks in `library/traceback.rst` (GH-113106)
(cherry picked from commit d9e1b5794a)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-14 14:17:28 +00:00
Miss Islington (bot)
dc568dd226
[3.12] gh-101100: Fix Sphinx nitpicks in library/inspect.rst and reference/simple_stmts.rst (GH-113107) (#113109)
gh-101100: Fix Sphinx nitpicks in `library/inspect.rst` and `reference/simple_stmts.rst` (GH-113107)
(cherry picked from commit 4b3cb082da)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-14 13:37:47 +00:00
Miss Islington (bot)
916ef4fbee
[3.12] Fixing typo in DocTestRunner docs (GH-112326) (GH-113097)
(cherry picked from commit b3c21265fa)

Co-authored-by: Daniel Wysocki <dwysocki@users.noreply.github.com>
2023-12-14 10:15:28 +00:00
Miss Islington (bot)
4d7c24b9a9
[3.12] gh-107959: clarify Unix-availability of os.lchmod() (GH-107960) (GH-113066)
gh-107959: clarify Unix-availability of `os.lchmod()` (GH-107960)

POSIX specifies that implementations are not required to support changing the
file mode of symbolic links, but may do so.
Consequently, `lchmod()` is not part of POSIX (but mentioned for implementations
which do support the above).

The current wording of the availability of `os.lchmod()` is rather vague and
improved to clearly tell which POSIX/Unix/BSD-like support the function in
general (those that support changing the file mode of symbolic links).
Further, some examples of major implementations are added.

Data for the BSDs taken from their online manpages.

(cherry picked from commit f14e3d59c9)

Signed-off-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
Co-authored-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-12-13 20:01:39 +00:00
Miss Islington (bot)
d84aa5cd28
[3.12] Docs: Fix external link to devguide.python.org (GH-112899) (#113065)
Co-authored-by: Miro Hrončok <miro@hroncok.cz>
2023-12-13 19:48:43 +00:00
Miss Islington (bot)
34714f4ac9
[3.12] gh-101100: Improve docs on exception attributes (GH-113057) (#113061)
gh-101100: Improve docs on exception attributes (GH-113057)

(cherry picked from commit d05a180350)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-13 19:07:19 +00:00
Miss Islington (bot)
3bf2a4a382
[3.12] gh-101100: Fix Sphinx warning in references with asterisks (GH-113029) (#113043)
gh-101100: Fix Sphinx warning in references with asterisks (GH-113029)
(cherry picked from commit 3531ea441b)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-13 08:59:47 +00:00
Miss Islington (bot)
e328115254
[3.12] gh-101100: Further improve docs on function attributes (GH-113001) (#113030)
gh-101100: Further improve docs on function attributes (GH-113001)
(cherry picked from commit 81a15ea74e)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-12 20:28:10 +00:00
Miss Islington (bot)
e34458905b
[3.12] gh-112999: Replace the outdated "deprecated" directives with "versionchanged" (GH-113000) (GH-113019)
(cherry picked from commit fe9991bb67)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-12-12 17:20:51 +00:00
Hugo van Kemenade
54fcfbde30
[3.12] gh-101100: Improve documentation on function attributes (GH-112933) (#112974)
(cherry picked from commit 4c5b9c107a)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-12 10:10:27 +00:00
Miss Islington (bot)
78a5010a4e
[3.12] GH-101986: Support translation for Limited/Unstable API & Stable ABI (GH-107680) (#112940)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-10 19:23:14 +00:00
Miss Islington (bot)
c108080626
Doc: c-api: fix order of PyMemberDef fields (GH-112879)
Doc: c-api: fix order of PyMemberDef fields (GH-112879)
(cherry picked from commit 42a86df3a3)
2023-12-10 17:50:05 +00:00