Commit graph

26232 commits

Author SHA1 Message Date
Miss Islington (bot)
f5f99756e1
[3.11] Minor improvements to typing docs (GH-104465) (#104475)
Minor improvements to typing docs (GH-104465)
(cherry picked from commit 2f7b5e458e)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-05-14 13:00:57 +01:00
Miss Islington (bot)
e794d469e3
[3.11] Add a mention of PYTHONBREAKPOINT to breakpoint() docs (GH-104430) (#104447)
Add a mention of PYTHONBREAKPOINT to breakpoint() docs (GH-104430)
(cherry picked from commit 1be80ed107)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2023-05-13 07:16:28 +00:00
Erlend E. Aasland
7055088500
[3.11] gh-101117: Improve accuracy of sqlite3.Cursor.rowcount docs (#104287) (#104381)
The SQLite C API sqlite3_changes() can only be relied upon when the
current active statement has been run to completion.
2023-05-11 11:09:46 +02:00
Miss Islington (bot)
a8e902d2c2
[3.11] gh-104010: Separate and improve docs for typing.get_origin and typing.get_args (GH-104013) (#104359)
* separate documentation and examples for both functions
* add examples demonstrating behaviour with unsupported types
* document return value of `get_origin` for `ParamSpecArgs` and `ParamSpecKwargs` instances

(cherry picked from commit a7a2dbbf72)

Co-authored-by: chgnrdv <52372310+chgnrdv@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-05-10 07:49:49 -07:00
Miss Islington (bot)
03abac239c
[3.11] gh-103960: Dark mode: invert image brightness (GH-103983) (#104358)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-05-10 14:19:38 +00:00
Miss Islington (bot)
2fa14d47af
[3.11] gh-48241: Clarify URL needs to be encoded when provided to urlopen and Request (GH-103855) (#103891)
(cherry picked from commit 44010d0f12)

Co-authored-by: Michael Blahay <mblahay@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2023-05-10 00:22:06 +02:00
Miss Islington (bot)
fffdbf4831
[3.11] gh-102327: Extend docs for "url" and "headers" parameters to HTTPConnection.request()
gh-102327: Extend docs for "url" and "headers" parameters to HTTPConnection.request()

Added example on how to use the HTTPConnection object for making GET request.

Original issue: https://github.com/python/cpython/issues/102327

---------

(cherry picked from commit 7ba6288feb)

Co-authored-by: David Foster <david@dafoster.net>
Co-authored-by: Éric <earaujo@caravan.coop>
2023-05-09 20:00:58 +00:00
Miss Islington (bot)
97e1e43af1
[3.11] [doc] logging.rst - Change link to point directly to the Google Group. (GH-93390) (GH-104318)
(cherry picked from commit e6e81602f4)
2023-05-09 15:31:00 +01:00
Shantanu
15624b445e
[3.11] gh-102500: collections.abc.Buffer doesn't exist in 3.11 (#104317) 2023-05-09 10:27:15 +01:00
Miss Islington (bot)
2ee250383f
[3.11] GH-104284: Fix documentation gettext build (GH-104296) (#104299)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-08 13:17:42 -06:00
Miss Islington (bot)
8a6ff59e09
[3.11] GH-104145: Use fully-qualified cross reference types for the bisect module (GH-104172) (#104295)
GH-104145: Use fully-qualified cross reference types for the bisect module (GH-104172)
(cherry picked from commit 76eef552f3)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-08 17:41:20 +01:00
Alex Waygood
499b79d0b9
[3.11] gh-102500: Remove mention of bytes shorthand (#104281) (#104288)
gh-102500: Remove mention of bytes shorthand (#104281)

The bytes shorthand was removed in PEP 688:
https://peps.python.org/pep-0688/#no-special-meaning-for-bytes

The reference to collections.abc.ByteString is also removed, since that object is deprecated (#91896) and has different semantics (#102092)

Although PEP 688 is new in Python 3.12, type checkers are expected to implement the new semantics for type annotations even if users are using an older version of Python, so this docs PR is backported to Python 3.11.

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-08 15:23:10 +01:00
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
Erlend E. Aasland
a635d63860
[3.11] gh-64658: Expand Argument Clinic return converter docs (#104175) (#104198) 2023-05-05 13:46:23 +02: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
Adam Turner
99e6314d93
[3.11] GH-97950: Use new-style index directive ('exception') (GH-104160) (#104161) 2023-05-04 13:48:57 +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
Miss Islington (bot)
a9fcf01ed9
[3.11] GH-97950: Use new-style index directive ('keyword') (GH-104153) (#104155)
GH-97950: Use new-style index directive ('keyword') (GH-104153)

* Uncomment keyword removal in pairindextypes

* Use new-style index directive ('keyword') - Reference
(cherry picked from commit 33ca322c50)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-04 10:53:19 +02: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)
8f94c9465b
[3.11] GH-97950: Allow translation of index directive content (GH-104000) (#104151)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-04 10:26:08 +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
Irit Katriel
5386730cdd
[3.11] gh-103590: do not wrap a single exception raised from a try-except* (#104094) 2023-05-02 19:24:02 +01: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
Hugo van Kemenade
b07bae6971
[3.11] Replace Netlify with Read the Docs build previews (#103843) (#104083)
Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-05-02 05:29:27 +00:00
Miss Islington (bot)
723aacb7d5
[3.11] gh-100458: Clarify Enum.__format__() change of mixed-in types in the whatsnew/3.11.rst (GH-100387) (GH-104060)
Co-authored-by: Anže Pečar <anze@pecar.me>
Co-authored-by: JosephSBoyle <48555120+JosephSBoyle@users.noreply.github.com>
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2023-05-01 13:06:09 -07: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
Inada Naoki
4041251a36
gh-103883: Doc: Move PyUnicode_FromObject doc (GH-103913)
This API is one of Unicode creator APIs.
This APIs should not be placed in PEP 393 deprecated APIs.

Fixes: gh-103883

(cherry picked from commit ce2383ec66)
2023-04-27 15:05:35 +09: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)
97711de594
[3.11] Docs build: Add upper bounds to transitive dependencies (GH-103860) (#103887)
Docs build: Add upper bounds to transitive dependencies (GH-103860)
(cherry picked from commit 81cf94c442)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-04-26 11:19:15 -06: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