Commit Graph

12138 Commits

Author SHA1 Message Date
Miss Islington (bot) ada22db147
[3.11] Clarify state of CancelledError in doc (GH-106453) (#106456)
Clarify state of CancelledError in doc (GH-106453)

This change makes it explicit that asyncio.CancelledError is not a subclass of Exception.
(cherry picked from commit 12a9813808)

Co-authored-by: Kristján Valur Jónsson <sweskman@gmail.com>
2023-07-05 11:16:56 -07:00
Miss Islington (bot) 23b731a10d
[3.11] GH-104554: Add RTSPS support to `urllib/parse.py` (GH-104605) (#105760)
RTSPS is the permanent scheme defined in
https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml
alongside RTSP and RTSPU schemes.

---------

(cherry picked from commit f3266c05b6)

Co-authored-by: zentarim <33746047+zentarim@users.noreply.github.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
2023-07-05 13:02:36 +02:00
Miss Islington (bot) f5e29f4245
[3.11] gh-101100: Docs: Fix references to several numeric dunders (GH-106278) (#106282)
gh-101100: Docs: Fix references to several numeric dunders (GH-106278)
(cherry picked from commit a8ae73965b)

Co-authored-by: F3eQnxN3RriK <drsuaimqjgar@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-30 15:40:13 +01:00
Miss Islington (bot) b952ebe4be
[3.11] gh-100408: Fix a traceback in multiprocessing example (GH-100409) (GH-106231)
(cherry picked from commit a28d4edb23)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-06-29 14:29:22 +03:00
Miss Islington (bot) ce091c96cf
[3.11] gh-101100: Fix reference to `parse_args` in `optparse.rst` (GH-105265) (#106205)
Co-authored-by: F3eQnxN3RriK <drsuaimqjgar@gmail.com>
2023-06-28 12:41:18 +00:00
Miss Islington (bot) 0523f6de1f
[3.11] gh-105993: Add possible `None` return type to `asyncio.EventLoop.start_tls` docs (GH-105995) (#106189)
gh-105993: Add possible `None` return type to `asyncio.EventLoop.start_tls` docs (GH-105995)
(cherry picked from commit 6b52a581c1)

Co-authored-by: Sam Bull <git@sambull.org>
2023-06-28 16:36:25 +05:30
Miss Islington (bot) 43c603a60f
[3.11] gh-101100: Fix reference to asynchronous methods (GH-106172) (#106192)
gh-101100: Fix reference to asynchronous methods (GH-106172)
(cherry picked from commit bbf722dcd3)

Co-authored-by: F3eQnxN3RriK <drsuaimqjgar@gmail.com>
2023-06-28 16:35:51 +05:30
Miss Islington (bot) 2cce465416
[3.11] Refer to `TimeoutError` instead of `asyncio.TimeoutError` in `asyncio-task.rst` (GH-106136) (#106180)
Co-authored-by: lightdrk <108566237+lightdrk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-06-27 23:38:26 -06:00
Miss Islington (bot) 86dbf1d112
[3.11] gh-92788: Add docs for `ast.Module`, `ast.Expression`, and others (GH-101055) (#106138)
gh-92788: Add docs for `ast.Module`, `ast.Expression`, and others (GH-101055)
(cherry picked from commit 33608fd67d)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-06-27 13:44:32 +00:00
Miss Islington (bot) 956b66b61b
[3.11] GH-105774: Clarify operation of normalize() (GH-106093) (GH-106129) 2023-06-26 23:32:43 -05:00
Miss Islington (bot) 97cf0291f5
[3.11] gh-106107: document correct error that's raised when a mutable default value for a field is detected (gh-106109) (gh-106116)
gh-106107: document correct error that's raised when a mutable default value for a field is detected (gh-106109)
(cherry picked from commit 512f299e55)

Co-authored-by: Roderich Schupp <roderich.schupp@gmail.com>
2023-06-26 14:12:40 -04:00
Miss Islington (bot) 8c792749cb
[3.11] Improve typing docs on the type of class objects (GH-106081) (#106097)
Improve typing docs on the type of class objects (GH-106081)
(cherry picked from commit 3eeb8c8906)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-26 09:43:41 +01:00
Miss Islington (bot) 1bbf60dc31
[3.11] Docs: add links to 'callable' term in sqlite3 docs (GH-106072) (#106074)
(cherry picked from commit bef1c8761e)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-06-25 10:16:30 +02:00
Miss Islington (bot) 05d06e583b
[3.11] Typing docs: fix typo in annotating tuples comment (GH-106048) (#106050)
Typing docs: fix typo in annotating tuples comment (GH-106048)
(cherry picked from commit 8ef0ee4ebc)

Co-authored-by: Eamon Tracey <66919574+EamonTracey@users.noreply.github.com>
2023-06-23 21:35:16 +01:00
Miss Islington (bot) 15f4bba7a7
[3.11] Typing docs: improve the guidance on annotating tuples (GH-106021) (#106029)
Typing docs: improve the guidance on annotating tuples (GH-106021)
(cherry picked from commit 968435ddb1)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-23 15:53:14 +01:00
Miss Islington (bot) 6d232ba2ec
[3.11] stdtypes.rst: remove a period (GH-105959) (#105969)
stdtypes.rst: remove a period (GH-105959)
(cherry picked from commit c5a722be5f)

Co-authored-by: Mathieu Dupuy <deronnax@gmail.com>
2023-06-21 15:40:46 +01:00
Alex Waygood 8bb16f6656
[3.11] typing docs: Improve the intro to each section (#105901) (#105903)
typing docs: Improve the intro to each section (#105901)
2023-06-19 01:17:06 +01:00
Carl Meyer 7c877b58e0
[3.11] bpo-44530: Document the change in MAKE_FUNCTION behavior (GH-93189) (#105842)
* bpo-44530: Document the change in MAKE_FUNCTION behavior

Fixes dis module documentation for MAKE_FUNCTION due to 2f180ce2cb (bpo-44530, released as part of 3.11) removes the qualified name at TOS.
(cherry picked from commit 486b52a315)

Co-authored-by: Alex Doe <alexdoesh@gmail.com>
2023-06-16 12:17:58 -05:00
Miss Islington (bot) aa927f9f96
[3.11] tarfile: Fix positional-only syntax in docs (GH-105770) (#105772)
The syntax used in the current docs (a / before any args) is invalid.

I think the right approach is for the arguments to arbitrary
filter functions to be treated as positional-only, meaning that users
can supply filter functions with any names for the argument. tarfile.py
only calls the filter function with positional arguments.
(cherry picked from commit 5cdd5ba49d)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-06-15 22:43:30 -07:00
Alex Waygood 6be46c37c6
[3.11] More reorganisation of the typing docs (#105787) (#105816) 2023-06-15 10:05:50 +01:00
Alex Waygood c197bd8826
[3.11] Improve docs for `typing.dataclass_transform` (#105792) (#105815)
(cherry-picked from commit 006a453205)
2023-06-15 09:56:14 +01:00
Alex Waygood ab0546881f
[3.11] Typing docs: move the deprecated stuff below the non-deprecated stuff (#105781) (#105785) 2023-06-14 15:40:02 +01:00
Alex Waygood f207b346d4
[3.11] Remove stray reference to PEP-695 in the typing docs (#105655) 2023-06-11 17:10:49 +01:00
Miss Islington (bot) aaa8a493ec
[3.11] Cleanup and clarify our hashlib docs. (GH-105624) (#105633)
Cleanup and clarify our hashlib docs. (GH-105624)

Clarify and improve our hashlib docs. Now with 50% less mess!
(cherry picked from commit 0d1d6ab966)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2023-06-10 11:50:27 -07:00
Alex Waygood 6cb1308005
[3.11] Miscellaneous improvements to the typing docs (#105529) (#105568)
Miscellaneous improvements to the typing docs (#105529)

Mostly, these are changes so that we use shorter sentences and shorter paragraphs. In particular, I've tried to make the first sentence introducing each object in the typing API short and declarative.
2023-06-09 22:41:22 +01:00
Miss Islington (bot) c28887d059
[3.11] Clarify the supported cases in the tokenize module (GH-105569) (#105574)
Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
2023-06-09 16:00:53 +00:00
Alex Waygood faf15fda28
[3.11] Fix two errors in the typing docs (#105559) 2023-06-09 14:14:47 +01:00
Miss Islington (bot) af80db063f
[3.11] Further improve docs for `typing.Annotated` (GH-105498) (#105504)
* Further improve docs for `typing.Annotated` (GH-105498)
(cherry picked from commit d213c2990f)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-08 15:06:39 +00:00
Alex Waygood 02c5513b30
[3.11] [typing docs] Don't describe `Sized` and `Hashable` as deprecated in the 3.11 docs (#105496) 2023-06-08 13:09:52 +01:00
Alex Waygood ccc971714e
[3.11] typing: Improve documentation of generic classes and aliases (#105369) (#105454) 2023-06-07 21:27:15 +00:00
Miss Islington (bot) 40d1d28b07
[3.11] gh-90015: Document that PEP-604 unions do not support forward references (GH-105366) (#105461)
gh-90015: Document that PEP-604 unions do not support forward references (GH-105366)
(cherry picked from commit fbdee000de)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-07 19:11:33 +01:00
Jelle Zijlstra 34f23904e1
[3.11] Improve docs for `typing.TypeAlias` (GH-105372). (#105447)
(cherry picked from commit c5ec51ec8f)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-07 07:14:36 -07:00
Jelle Zijlstra d0af5272a7
[3.11] gh-97797: Improve documentation for typing.Annotated (GH-105365). (#105449)
(cherry picked from commit e26d296984)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-07 07:14:01 -07:00
Alex Waygood 0d2ed56f6c
[3.11] Improve code examples in `typing.rst` (#105346) (#105427) 2023-06-07 06:41:35 -07:00
Miss Islington (bot) 039f30380b
[3.11] typing docs: Make the PEPs list an expandable section, hidden by default (GH-105353) (#105421)
typing docs: Make the PEPs list an expandable section, hidden by default (GH-105353)
(cherry picked from commit d7645124f5)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-06-07 07:50:31 +01:00
Miss Islington (bot) 5e4c46f029
[3.11] GH-95088: Clarify rules for parsing an item key for format strings (GH-103779) (#105418)
GH-95088: Clarify rules for parsing an item key for format strings (GH-103779)
(cherry picked from commit 3e7316d7e8)

Co-authored-by: achhina <amanschhina@gmail.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-06-06 20:56:03 -07:00
Miss Islington (bot) 2456136360
[3.11] `typing.NewType` docs: the future performance improvements are now in the past (GH-105354) (#105415)
`typing.NewType` docs: the future performance improvements are now in the past (GH-105354)
(cherry picked from commit 5f65ff0370)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-06 20:55:46 -07:00
Miss Islington (bot) faae548e0e
[3.11] gh-89412: Add missing attributes (added in 3.10) to traceback module docs (GH-105046) (#105328)
(cherry picked from commit a4f72fa39a)

Co-authored-by: Jakub Kuczys <me@jacken.men>
2023-06-05 19:02:23 +02:00
Miss Islington (bot) 86eab0807f
[3.11] gh-104882: Docs: fix description of relationship between `socket.getblocking()` and `socket.gettimeout()` (GH-105026) (#105284)
gh-104882: Docs: fix description of relationship between `socket.getblocking()` and `socket.gettimeout()` (GH-105026)
(cherry picked from commit 5a5ed7a3e6)

Co-authored-by: Joe Geisbauer <joegeisbauer@gmail.com>
2023-06-04 17:09:13 +01:00
Victor Stinner 5de6ca59fb
[3.11] gh-105096: Reformat wave documentation (#105136) (#105138) (#105155)
[3.12] gh-105096: Reformat wave documentation (#105136) (#105138)

gh-105096: Reformat wave documentation (#105136)

Add ".. class::" markups in the wave documentation.

* Reformat also wave.py (minor PEP 8 changes).
* Remove redundant "import struct": it's already imported at top
  level.
* Remove wave.rst from .nitignore

(cherry picked from commit 85e5d03163)
(cherry picked from commit 01b42f9559)
2023-05-31 16:40:25 +00:00
Miss Islington (bot) c39500db52
[3.11] GH-89455: Add missing attributes (added in 3.11) to traceback module docs (GH-105044) (#105067)
GH-89455: Add missing attributes (added in 3.11) to traceback module docs (GH-105044)
(cherry picked from commit 39f6a0489f)

Co-authored-by: Jakub Kuczys <me@jacken.men>
2023-05-29 20:37:49 +01:00
Jelle Zijlstra d34e58a1d5
[3.11] gh-103921: Improve typing documentation (GH-104642) (#105007)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-05-27 16:30:41 -07:00
Miss Islington (bot) a632697225
[3.11] gh-104984: remove kwargs and starargs from Call & ClassDef (GH-104986) (#104988)
gh-104984: remove kwargs and starargs from Call & ClassDef (GH-104986)

These fields are removed in 025e9ebd0a
(cherry picked from commit 61c1d6760f)

Co-authored-by: Shaygan Hooshyari <sh.hooshyari@gmail.com>
2023-05-26 18:14:03 +01:00
Miss Islington (bot) 3b3f2e107b
[3.11] gh-104874: Document NewType.__supertype__ (GH-104875) (#104907)
gh-104874: Document NewType.__supertype__ (GH-104875)
(cherry picked from commit 41768a2bd3)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-05-25 00:35:58 +01:00
Prince Roshan 2ade563abc
[3.11] gh-103606: Improve error message from logging.config.FileConfig (GH-103628) (#104687)
* gh-103606: Improve error message from logging.config.FileConfig (GH-103628)

(cherry picked from commit 152227b569)

plus backport the followup exception change fix to that in #104701
2023-05-21 12:17:18 -07:00
Jelle Zijlstra abb32de8c4
[3.11] typing docs: Move some classes out of the "Generics" section (GH-104707) (#104721)
- AnyStr can be used in type annotations, contrary to the section header
- Unpack can also be used in annotations, and its use is not restricted
  to generics. It makes more sense with other building blocks like Required.
- Protocol is not necessarily generic.

Also fix the indentation for two notes associated with Concatenate.

(cherry picked from commit ab71acd67b)

---------

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-05-21 14:31:26 +01:00
Miss Islington (bot) dc0c41b2e5
[3.11] Corrected identifier (GH-104713) (#104714)
Corrected identifier (GH-104713)
(cherry picked from commit 60993ba8b4)

Co-authored-by: William Sawyer <wmsawyer2609@gmail.com>
2023-05-21 02:06:17 -04:00
Miss Islington (bot) d45c1df83e
[3.11] gh-49174: document that the effect of calling gc.collect() during a collection is undefined (GH-104699) (#104703)
gh-49174: document that the effect of calling gc.collect() during a collection is undefined (GH-104699)
(cherry picked from commit 30488fa22a)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2023-05-20 20:12:52 +00:00
han-solo 89bd454cd9
[3.11] gh-104679 Fixed syntax highlighting in turtle docs (GH-104682). (#104695)
(cherry picked from commit 2c97878bb8)
2023-05-20 12:36:43 -04:00
Miss Islington (bot) e5b6f38df4
[3.11] docs: fix wrong indentation causing rendering error in dis page (GH-104661) (#104670)
docs: fix wrong indentation causing rendering error in dis page (GH-104661)
(cherry picked from commit 3bc94e678f)

Co-authored-by: Nyakku Shigure <sigure.qaq@gmail.com>
2023-05-19 23:25:43 +03:00