Commit graph

26188 commits

Author SHA1 Message Date
Miss Islington (bot)
026c3e9cc4
[3.11] gh-91687: modernize dataclass example typing (GH-103773) (#103774)
modernize dataclass example typing `list` rather than `List` and comment
as to that line being the alluded too error.
(cherry picked from commit 7ef614c1ad)

Co-authored-by: Allan Lago <35788148+alago1@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2023-04-25 18:16:05 +02:00
Miss Islington (bot)
05a25867ae
[3.11] gh-87452: Improve the Popen.returncode docs (#103771)
Clarifies that it remains None until a method checking the child process
status has been called and noticed it has terminated.
(cherry picked from commit 68f5836582)

Co-authored-by: Joshua Herman <30265+zitterbewegung@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2023-04-25 18:15:48 +02:00
Miss Islington (bot)
03f8d8f0d8
[3.11] ctypes docs: fix missing not in variadic functions section (GH-102611) (#103425)
(cherry picked from commit 975d220bbe)

Co-authored-by: mara004 <geisserml@gmail.com>
2023-04-25 16:21:39 +05:30
Łukasz Langa
56d50dd9fb
[3.11] gh-103810: Fix broken references in dataclasses (GH-103811) (#103813)
(cherry picked from commit 0f23eda4b9)

Co-authored-by: Olga Matoula <olgamatoula@gmail.com>
2023-04-24 23:29:03 +00:00
Hugo van Kemenade
9f4364355e
[3.11] gh-101100: Fix Sphinx warnings in argparse module (#103289) (#103803)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-04-24 22:15:04 +00:00
Miss Islington (bot)
6f92d3f01a
[3.11] gh-103765: Fix 'Warning: py:class reference target not found: ModuleSpec' (GH-103769) (#103799)
(cherry picked from commit d2745fe850)

Co-authored-by: Jaime Alonso Lorenzo <jaimealonsolorenzo@gmail.com>
2023-04-24 15:57:21 -06:00
Miss Islington (bot)
34df9e740d
[3.11] Change 'dependant' to 'dependent' (GH-103745) (#103754)
Co-authored-by: Christopher Chavez <chrischavez@gmx.us>
2023-04-24 08:22:24 -06:00
Miss Islington (bot)
e40db6e6ae
[3.11] Descriptor HowTo: Update to include attributes added in Python 3.10 (GH-103666) (#103680)
Descriptor HowTo:  Update to include attributes added in Python 3.10  (GH-103666)
(cherry picked from commit 7b134d3e71)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2023-04-24 15:05:14 +05:30
Kumar Aditya
16dabf9e56
[3.11] GH-78530: clarify docs for generators yielding tasks in asyncio.wait and asyncio.as_completed (#103748) 2023-04-24 14:33:12 +05:30
Rafael Fontenelle
8642fdce8c
[3.11] GH-103484: Fix broken links reported by linkcheck (GH-103608) (#103683)
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>
Fix broken links reported by linkcheck (#103608)
2023-04-23 23:26:15 +03:00
Miss Islington (bot)
a43dbe13e2
[3.11] gh-68654: Clarify subdirectories used by pkgutil.extend_path (GH-103701)
gh-68654: Clarify subdirectories used by pkgutil.extend_path (GH-103701)

Clarify sub directories used by pkgutil.extend_path in the docs and the docstring
(cherry picked from commit 7bf94568a9)

Co-authored-by: Randy <69558016+san-juan1667@users.noreply.github.com>
2023-04-23 02:57:10 -06:00
Miss Islington (bot)
050b6b34d0
[3.11] Revert "Avoid error lexing multiprocessing docs code block on Pygments 2.15.0" (GH-103616) (#103695)
Revert "Avoid error lexing multiprocessing docs code block on Pygments 2.15.0" (GH-103616)

This reverts commit ace51dcdb7.
(cherry picked from commit 8cb2b0f953)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-04-22 16:13:22 -06:00
Miss Islington (bot)
7f6710bab6
[3.11] GH-103475: cache() and lru_cache() do not have a "call once" guarantee (GH-103669) (#103682)
GH-103475: cache() and lru_cache() do not have a "call once" guarantee (GH-103669)
(cherry picked from commit e5eaac6064)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2023-04-22 09:54:58 -06:00
Miss Islington (bot)
2b5dbd1f23
Doc: Fix broken link to emscripten networking website (GH-99531)
There was an extra `>` in the url.
(cherry picked from commit ed206e39f0)

Co-authored-by: Alexander Ryabov <73594+haron@users.noreply.github.com>
2023-04-19 07:37:14 -07:00
Miss Islington (bot)
5a81a24c8b
gh-103582: Remove last references to argparse.REMAINDER from docs (GH-103586)
(cherry picked from commit f4d087964e)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-04-18 22:14:53 -07:00
Miss Islington (bot)
1dad3d1071
GH-103484: Docs: add linkcheck allowed redirects entries for most cases (GH-103569)
(cherry picked from commit f39e00f952)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-04-17 20:06:52 -07:00
Miss Islington (bot)
4c4ef50ec2
GH-83893: Cross reference env. vars and -X command line options (GH-103414)
(cherry picked from commit d65ed693a8)

Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
Co-authored-by: Erlend E. Aasland
2023-04-16 16:09:50 -07:00
Ethan Furman
3b929a7b32
[3.11] gh-103479: [Enum] require __new__ to be considered a data type (GH-103495) (GH-103514)
a mixin must either have a __new__ method, or be a dataclass, to be interpreted as a data-type; an __init__ method is not enough (restores pre-3.11 behavior for non-dataclasses).

(cherry picked from commit a6f95941a3)
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2023-04-13 12:04:06 -07:00
Miss Islington (bot)
804a973d8e
gh-103365: [Enum] STRICT boundary corrections (GH-103494)
STRICT boundary:

- fix bitwise operations
- make default for Flag
(cherry picked from commit 2194071540)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2023-04-13 08:55:53 -07:00
Miss Islington (bot)
e643412ef4
gh-103417: use time.monotonic in the example for sched.scheduler (GH-103418)
(cherry picked from commit f2b7ecb778)

Co-authored-by: Nick Burns <nburns@users.noreply.github.com>
2023-04-12 02:09:08 -07:00
Miss Islington (bot)
b5fe28dace
gh-103237: Polish pdb docs (GH-103238)
(cherry picked from commit 449bf2a76b)

Co-authored-by: Tian Gao <gaogaotiantian@hotmail.com>
2023-04-11 23:26:33 -07:00
Miss Islington (bot)
e715da6db1
gh-87864: Use correct function definition syntax in the docs (GH-103312)
(cherry picked from commit 50b4b15984)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-04-11 07:19:33 -07:00
Miss Islington (bot)
07a2851edb
gh-103373: __mro_entries__ docs: improve cross references (GH-103398)
(cherry picked from commit e071f00aae)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-04-11 03:34:46 -07:00
Miss Islington (bot)
a836d79111
Docs: don't render files in includes/, they're for embedding only (GH-103313)
(cherry picked from commit 280bd536b5)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-04-10 23:26:07 -07:00
Miss Islington (bot)
4a05392adb
Doc: Avoid error lexing multiprocessing docs code block on Pygments 2.15.0 (GH-103421)
(cherry picked from commit 75b6ab80da)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-04-10 21:07:21 -07:00
Miss Islington (bot)
b80e4c89d8
[3.11] gh-103059: Clarify gc.freeze documentation (GH-103058) (#103416)
gh-103059: Clarify gc.freeze documentation (GH-103058)
(cherry picked from commit 8b1b17134e)

Co-authored-by: raylu <lurayl@gmail.com>
2023-04-10 11:17:48 -06:00
Miss Islington (bot)
77359a86b8
gh-103373: Improve documentation for __mro_entries__ (GH-103374)
(cherry picked from commit 0ba0ca05d2)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-04-08 07:16:43 -07:00
Miss Islington (bot)
7b03d0f7c5
gh-100574: add examples/links to the strptime/strftime docs (GH-100575)
(cherry picked from commit 3310b94d3d)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-04-08 01:56:31 -07:00
Miss Islington (bot)
31bec9198b
Docs: use Node.findall to avoid a deprecation warning (GH-99403)
(cherry picked from commit 1e9dfdacef)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-04-08 01:24:27 -07:00
Miss Islington (bot)
bbe04d9d1c
gh-103266: Fix a typo in example code for bisect() function (GH-103267)
(cherry picked from commit f0424ba4b6)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2023-04-06 17:45:07 -07:00
Ethan Furman
58e330ac9c
[3.11] gh-93910: [Enum] remove member.member deprecation (GH-103236) (GH-103299)
i.e. Color.RED.BLUE is now officially supported..
(cherry picked from commit 4ec8dd10bd)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2023-04-05 21:29:14 -07:00
Miss Islington (bot)
09fb27fa51
gh-102899: Fix doc link for getting filesystem error handler (GH-102901)
(cherry picked from commit fdd0fff277)

Co-authored-by: Olivier Gayot <olivier.gayot@sigexec.com>
2023-04-05 08:03:47 -07:00
Miss Islington (bot)
9357fc9b89
gh-81762: Clarify and simplify description of print's flush param (GH-103264)
(cherry picked from commit c396b6ddf3)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-04-05 04:49:08 -07:00
Miss Islington (bot)
6258c3cd53
Improve some grammar in the socket docs (GH-103254)
(cherry picked from commit bceb9e00ad)

Co-authored-by: Tim Burke <tim.burke@gmail.com>
2023-04-04 15:54:37 -07:00
Miss Islington (bot)
cf72cc25f6
gh-98298, gh-74730: [Enum] update docs (GH-103163)
fix FlagBoundary statements
add warning about reloading modules and enum identity
(cherry picked from commit 5ffc1e5a21)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2023-04-03 15:27:33 -07:00
Miss Islington (bot)
823622212e
gh-102994: Profile docs has typo in example (GH-103074)
(cherry picked from commit 55decb72c4)

Co-authored-by: Nouran Ali <nouranalimohammed@gmail.com>
2023-04-02 15:52:11 -07:00
Miss Islington (bot)
0854bdf15f
gh-103109: Document ignore_warnings() test support helper (GH-103110)
(cherry picked from commit 32937d6aa4)

Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-04-02 15:42:43 -07:00
Miss Islington (bot)
4664a7cf68
Quote literal tokens in standard format specifier grammar (GH-102902)
Reported by Damian Dureck: https://mail.python.org/archives/list/docs@python.org/thread/UZTWBJIXC3MBKTHXVTIBPGDPKBNWZ5LN/
(cherry picked from commit f6405a4662)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2023-03-31 05:52:52 -07:00
Miss Islington (bot)
41e3ea1396
Minor docs improvements fix for codeop (GH-103123)
(cherry picked from commit c1e71ce56f)

Co-authored-by: gaogaotiantian <gaogaotiantian@hotmail.com>
2023-03-30 15:58:54 -07:00
Miss Islington (bot)
1b40618247
gh-103099: Link mypy docs from typing.rst (GH-103100)
(cherry picked from commit fda95aa194)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-03-30 01:39:49 -07:00
Miss Islington (bot)
d189e2db0b
[3.11] gh-102582: Fix invalid JSON in Doc/howto/logging-cookbook.rst (GH-102635) (GH-103106)
(cherry picked from commit d835b3f05d)

Co-authored-by: Matěj Cepl <mcepl@cepl.eu>
2023-03-29 10:04:53 +01:00
Miss Islington (bot)
e1094c6e6a
Update pdb docs for arguments (GH-102965)
(cherry picked from commit 027223db96)

Co-authored-by: gaogaotiantian <gaogaotiantian@hotmail.com>
2023-03-25 14:42:28 -07:00
Miss Islington (bot)
aae91fa63c
[3.11] gh-103025: fix a ctypes doc typo (GH-103026) (#103029)
* gh-103025: fix two ctypes doc issues  (GH-103026)
(cherry picked from commit 0708437ad0)

Co-authored-by: Peter Jiping Xie <peter.jp.xie@gmail.com>
2023-03-25 10:00:44 +00:00
Hugo van Kemenade
85c686a1a5
[3.11] gh-101100: Document PyObject_ClearWeakRefs, gzip's name, and asyncio.iscoroutine (#103001) 2023-03-25 09:43:52 +02:00
Miss Islington (bot)
c834a4c713
gh-102873: logging.LogRecord docs: improve description of msg parameter (GH-102875)
(cherry picked from commit f2e5a6ee62)

Co-authored-by: Amin Alaee <mohammadamin.alaee@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-24 08:08:48 -07:00
Miss Islington (bot)
e075631f67
[3.11] gh-96931: Fix incorrect results in ssl.SSLSocket.shared_ciphers (GH-96932) (#102918)
gh-96931: Fix incorrect results in ssl.SSLSocket.shared_ciphers (GH-96932)
(cherry picked from commit af9c34f6ef)

Co-authored-by: Benjamin Fogle <benfogle@gmail.com>
2023-03-24 13:33:24 +01:00
Miss Islington (bot)
60b2b58f87
[3.11] Minor readability improvement to the factor() recipe (GH-102971) (GH-102972) 2023-03-23 14:56:35 -05:00
Miss Islington (bot)
202e16ea05
gh-98239: Document that inspect.getsource() can raise TypeError (GH-101689)
(cherry picked from commit b6132085ca)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-03-23 12:42:54 -07:00
Miss Islington (bot)
e2924c0ee5
gh-102936: typing: document performance pitfalls of protocols decorated with @runtime_checkable (GH-102937)
(cherry picked from commit 58d2b30c01)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-23 11:27:28 -07:00
Miss Islington (bot)
84ae50c914
gh-102810 Improve the sphinx docs for asyncio.Timeout (GH-102934)
(cherry picked from commit f13fdacadf)

Co-authored-by: JosephSBoyle <48555120+JosephSBoyle@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-23 09:52:43 -07:00