Commit graph

12073 commits

Author SHA1 Message Date
Miss Islington (bot)
efcd4bcb87
[3.11] gh-104254: Document the optional keyword-only "context" argument to Task constructor (GH-104251) (#104258)
gh-104254: Document the optional keyword-only "context" argument to Task constructor (GH-104251)

(This was added in 3.11. It was already documented for `create_task()`, but not for `Task()`.)
(cherry picked from commit 4ee2068c34)

Co-authored-by: Itamar Ostricher <itamarost@gmail.com>
2023-05-07 09:52:23 +05:30
Miss Islington (bot)
4b11af058e
[3.11] GH-97950: Use new-style index directive ('builtin') (GH-104164) (#104221)
GH-97950: Use new-style index directive ('builtin') (GH-104164)

* Uncomment builtin removal in pairindextypes

* Use new-style index directive ('builtin') - C API

* Use new-style index directive ('builtin') - Extending

* Use new-style index directive ('builtin') - Library

* Use new-style index directive ('builtin') - Reference

* Use new-style index directive ('builtin') - Tutorial
(cherry picked from commit f5088006ca)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-06 07:14:37 +03:00
Miss Islington (bot)
bb4369e15f
[3.11] gh-104112: link from cached_property docs to method-caching FAQ (GH-104113) (#104182)
gh-104112: link from cached_property docs to method-caching FAQ (GH-104113)
(cherry picked from commit fa86a77589)

Co-authored-by: Carl Meyer <carl@oddbird.net>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-04 17:10:34 -06:00
Miss Islington (bot)
6a970ae666
[3.11] GH-97950: Use new-style index directive ('statement') (GH-104162) (#104163)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-04 13:57:14 +03:00
Miss Islington (bot)
c463796ba7
[3.11] GH-97950: Use new-style index directive ('object') (GH-104158) (#104159)
GH-97950: Use new-style index directive ('object') (GH-104158)

* Uncomment object removal in pairindextypes

* Use new-style index directive ('object') - C API

* Use new-style index directive ('object') - Library

* Use new-style index directive ('object') - Reference

* Use new-style index directive ('object') - Tutorial
(cherry picked from commit 6ab463684b)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-04 13:14:16 +03:00
Miss Islington (bot)
693ef48df1
[3.11] GH-97950: Use new-style index directive ('operator') (GH-104156) (#104157)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-04 12:27:04 +03:00
Adam Turner
00563694bb
[3.11] GH-97950: Use new-style index directive ('module') (GH-103996) (#104154) 2023-05-04 11:39:15 +03:00
Miss Islington (bot)
365e0772c9
[3.11] gh-101100: Fix Sphinx warnings in curses and curses.ascii modules (GH-103457) (#104124)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-02 23:20:50 -06:00
Shantanu
f9231a09be
[3.11] gh-65022: Fix description of tuple return value in copyreg (GH-103892) (#104098)
(cherry picked from commit 587f2f0180)
2023-05-02 11:18:41 -07:00
Rafael Fontenelle
5e76305236
[3.11] GH-103484: Fix redirected permanently URLs (GH-104001) (#104088)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
Fix redirected permanently URLs (#104001)
2023-05-02 14:50:16 +03:00
Miss Islington (bot)
3e7e50e656
[3.11] Improve assert_type phrasing (GH-104081) (#104084)
Improve assert_type phrasing (GH-104081)

I'd like to make the fact that this does nothing at runtime
really obvious, since I suspect this is unintuitive for users who are
unfamiliar with static type checking.

I thought of this because of
https://discuss.python.org/t/add-arg-check-type-to-types/26384
wherein I'm skeptical that the user really did want `assert_type`.
(cherry picked from commit 82ba6ce303)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-02 08:44:16 +01:00
Miss Islington (bot)
d8055b889c
[3.11] Adjust expression from == to != in alignment with the meaning of the paragraph. (GH-104021) (GH-104031)
(cherry picked from commit 93107aa2a4)
2023-05-01 06:58:33 +01:00
Shantanu
86ef1ce121
[3.11] Fix description of MAKE_CELL (#103986)
Backport of part of #103923
2023-04-29 06:12:46 -07:00
Miss Islington (bot)
9fbb614c4e
[3.11] gh-99032: datetime docs: Encoding is no longer relevant (GH-93365) (#103788)
This removes a section of the `strftime` and `strptime` documentation that refers to a bygone era when `strftime` would return an encoded byte string.

---------

(cherry picked from commit 2aa22f72fb)

Co-authored-by: William Andrea <william.j.andrea@gmail.com>
Co-authored-by: Paul Ganssle <1377457+pganssle@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2023-04-28 20:09:55 -07:00
Petr Viktorin
241f2e54a6
[3.11] gh-102950: Implement PEP 706 – Filter for tarfile.extractall (GH-102953) (GH-103832)
See [Backporting & Forward Compatibility in PEP 706](https://peps.python.org/pep-0706/#backporting-forward-compatibility).

- Backport b52ad18a76
- Backport c8c3956d90
- Remove the DeprecationWarning
- Adjust docs
- Remove new `__all__` entries
2023-04-28 17:41:09 +02:00
Erlend E. Aasland
b3faf8ceec
[3.11] gh-100021: Document that sqlite3's executemany() discards resulting rows (#103939) (#103966) 2023-04-28 08:05:14 +00:00
Erlend E. Aasland
294398c102
[3.11] Docs: fix dunders with too many underscores (#103955) (#103957) 2023-04-27 22:27:59 +00:00
Adam Turner
dbc44fab7a
[3.11] GH-103903: Test the minimum Sphinx version in CI (#103904) (#103948)
[3.11] GH-103903: Test the minimum Sphinx version in CI (GH-103904).

(cherry picked from commit 44b5c21f41)
2023-04-27 20:55:09 +00:00
Alex Waygood
d20758c4ef
[3.11] gh-51574: Document behaviour of mkdtemp on 3.11 and lower (#103844) 2023-04-27 07:56:55 -07:00
Shantanu
c0b538b02f
[3.11] gh-101786: Clarify docs that asyncio.Server.sockets is a socket-like TransportSocket (GH-103877) (#103890)
Clarify that asyncio.Server.sockets is a socket-like TransportSocket
(cherry picked from commit 1c0a9c5a1c)

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2023-04-26 15:03:34 -06:00
Miss Islington (bot)
410c2ce956
[3.11] gh-94300: Update datetime.strptime documentation (GH-95318) (#103785)
gh-94300: Update datetime.strptime documentation (GH-95318)

The new wording better reflects the cases where `datetime.strptime` differs from` time.strptime`.

---------

(cherry picked from commit 5b404d6cad)

Co-authored-by: Howie Zhao <howiezhaohr@hotmail.com>
Co-authored-by: Paul Ganssle <git@m.ganssle.io>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Alexander Belopolsky <abalkin@users.noreply.github.com>
2023-04-26 14:55:39 -06:00
Miss Islington (bot)
bce93c2d83
[3.11] gh-101879: docs - italicize argument in smtplib.SMPT() description (GH-101886) (#103888)
gh-101879: docs - italicize argument in smtplib.SMPT() description (GH-101886)
(cherry picked from commit 28a05f4cc2)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-04-26 16:37:32 -04:00
Miss Islington (bot)
d9aafe2499
[3.11] gh-103721: Improve cross-references for generic-alias docs (GH-103838) (#103840)
Cc. @adriangb

The "stub documentation" in `types.rst` does already link to the
in-depth docs in `stdtypes.rst`, but the link isn't obvious for new
users. It deserves to be made more prominent.

- Issue: https://github.com/python/cpython/issues/103721
(cherry picked from commit cef542ca57)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-04-25 22:58:25 +00:00
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
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)
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)
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)
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)
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
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