Commit Graph

911 Commits

Author SHA1 Message Date
Miss Islington (bot) 9b3447ca3c [3.11] gh-101100: Improve docs on exception attributes (GH-113057) (#113062)
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
Alex Waygood b8a6eeec39 [3.11] gh-101100: Further improve docs on function attributes (#113001) (#113031)
(cherry-picked from commit 81a15ea74e)
2023-12-12 20:36:51 +00:00
Alex Waygood f83087ce03 [3.11] gh-101100: Improve documentation on function attributes (#112933) (#113003)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-12 14:19:02 +02:00
Miss Islington (bot) 58219bfce6 [3.11] Docs: Use 'f-strings' as header (GH-112888) (#112924)
Docs: Use 'f-strings' as header (GH-112888)
(cherry picked from commit 5bf7580d72)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-10 11:36:25 +02:00
Miss Islington (bot) c95aa4e310 [3.11] gh-101100: Improve documentation of TracebackType attributes (GH-112884) (#112912)
gh-101100: Improve documentation of `TracebackType` attributes (GH-112884)
(cherry picked from commit 96f64a2b1b)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-09 22:50:01 +00:00
Miss Islington (bot) 161cfd0dda [3.11] gh-101100: Improve documentation for attributes on instance methods (GH-112832) (#112873)
gh-101100: Improve documentation for attributes on instance methods (GH-112832)
(cherry picked from commit ed21d0c1f4)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-08 13:25:05 +00:00
Alex Waygood 5fa2d24002 [3.11] gh-101100: Improve documentation of code object attributes (#112781) (#112817)
(cherry-picked from commit e9707d3c3d)
2023-12-06 22:23:20 +00:00
Alex Waygood c26d6c1aba [3.11] gh-101100: Properly document frame object attributes (#112735) (#112775)
* [3.11] gh-101100: Properly document frame object attributes (#112735)

(cherry-picked from commit d109f637c0)
2023-12-05 20:23:25 +00:00
Miss Islington (bot) 80c314c9ce [3.11] gh-101100: Fix many easily solvable Sphinx nitpicks in the datamodel docs (GH-112737) (#112749)
gh-101100: Fix many easily solvable Sphinx nitpicks in the datamodel docs (GH-112737)
(cherry picked from commit 2f20cafdbf)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-05 10:06:30 +00:00
Miss Islington (bot) 05ea7e5d4d [3.11] gh-101100: Fix most Sphinx nitpicks in inspect.rst (GH-112662) (#112667)
gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662)
(cherry picked from commit 45650d1c47)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-03 17:39:10 +00:00
Miss Islington (bot) 49005e4d02 [3.11] gh-112331: Fix reference manual description of attribute lookup mechanics (gh-112375) (gh-112413) 2023-11-25 22:26:22 +00:00
Miss Islington (bot) b64afbc55c [3.11] gh-111944: Add assignment expression parentheses requirements (GH-111977) (#112011)
Augment the list of places where parentheses are
required around assignnment statements.  In particular,
'a := 0' and 'a = b := 1' are syntax errors.
(cherry picked from commit 9a2f25d374)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-11-13 00:14:03 +00:00
Miss Islington (bot) f22cdecb19 [3.11] GH-101100: Fix reference warnings for `__enter__ and __exit__` (GH-110112) (#111076)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-10-19 18:34:27 +03:00
Miss Islington (bot) 1b60244b97 [3.11] GH-101100: Fix reference warnings for `__getitem__` (GH-110118) (#111074)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-10-19 18:33:12 +03:00
Miss Islington (bot) e60abeea30 [3.11] gh-110886 Doc: add a link to BNF Wikipedia article (GH-110887) (#110901)
Co-authored-by: partev <petrosyan@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-15 17:00:57 +00:00
Ezio Melotti eb492d32b6 [3.11] gh-110631: Fix reST indentation in Doc/reference (GH-110708) (#110741)
Fix wrong indentation in the Doc/reference dir..
(cherry picked from commit 41d8ec5a1b)
2023-10-12 02:01:48 +02:00
Serhiy Storchaka c534637106 [3.11] gh-109634: Use :samp: role (GH-109635) (GH-109778)
(cherry picked from commit 92af0cc580)

Co-authored-by: Jacob Coffee <jacob@z7x.org>
2023-09-29 09:39:31 +03:00
Adam Turner 5505bfd687 [3.11] Datamodel: Add headings to the standard type hierarchy (GH-108146) (#108484)
* [3.11] Datamodel: Add headings to the standard type hierarchy (GH-108146)

Dedent content according to the new layout..
(cherry picked from commit 2b7bff0655)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

* Fix indentation
2023-08-25 18:27:34 +03:00
Miss Islington (bot) 8cf3cae8c5 [3.11] Docs: Datamodel: Merge "Notes on using __slots__" with the parent section (GH-108400) (#108475)
(cherry picked from commit 7f5b1a0661)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-25 13:04:00 +02:00
Miss Islington (bot) 3c1bcae075 [3.11] gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386) (GH-107418)
(cherry picked from commit f2d07d3289)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-29 09:17:20 +03:00
Serhiy Storchaka cc76113cf8 [3.11] gh-106892: Use roles :data: and :const: for referencing module variables (GH-106894) (GH-106955)
(cherry picked from commit d036db728e)
2023-07-21 14:49:21 +03:00
Serhiy Storchaka 6bde1b9f04 [3.11] gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920) (GH-106952)
(cherry picked from commit fcc816dbff)
2023-07-21 14:48:30 +03:00
Miss Islington (bot) e0d951d68a [3.11] Replace the esoteric term 'datum' when describing dict comprehensions (GH-106119) (#106349)
Replace the esoteric term 'datum' when describing dict comprehensions (GH-106119)
(cherry picked from commit 987b712b4a)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2023-07-03 03:25:12 +00:00
Federico Caselli acf3916e84 [3.11] Add single value agen.athrow(value) signature to the 3.11 docs gh-105269 (#105468) 2023-06-07 23:30:33 +01:00
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) 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
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
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) 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) 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) 1f7eb8fe6c gh-100315: clarification to __slots__ docs. (GH-102621)
refer to tp_itemsize in discussion on "variable-length" built-in types
(cherry picked from commit 88c262c086)

Co-authored-by: T <tnie@tuta.io>
2023-03-14 02:32:09 -07:00
Alex Waygood a4fcd06c50 [3.11] Fix duplicated words in the docs (#102644)
(cherry-picked from commit f6ca71a422)

With grep utility found some duplicated words

Co-authored-by: Виталий Дмитриев <vitaldmit@bk.ru>
2023-03-13 14:31:50 +00:00
Miss Islington (bot) 78eee76185 gh-102011: use sys.exception() instead of sys.exc_info() in docs where possible (GH-102012)
(cherry picked from commit 4d3bc89a3f)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2023-02-21 03:06:20 -08:00
Miss Islington (bot) 4aeae28671 GH-101898: Fix missing term references for hashable definition (GH-101899)
Fix missing term references for hashable definition
(cherry picked from commit 3690688149)

Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
2023-02-14 02:45:42 -08:00
Miss Islington (bot) eba6b00953 [3.11] gh-81611: Improve range paragraph in 8.3 of language reference (GH-98353) (#100704)
gh-81611: Improve `range` paragraph in 8.3 of language reference (GH-98353)
(cherry picked from commit 8b1f125121)

Co-authored-by: 4l4k4z4m <alakazamjoined@gmail.com>
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-01-04 15:57:24 -05:00
Miss Islington (bot) b99ac1dbc0 fix grammer -> grammar typo in expressions.rst (GH-100683)
(cherry picked from commit 7feb6d2f85)

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
Automerge-Triggered-By: GH:AlexWaygood
2023-01-02 03:57:51 -08:00
Miss Islington (bot) 18ccb84697 gh-100201: Document behavior with a bare yield statement (GH-100416)
(cherry picked from commit 1aab269d4a)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-01-01 07:44:27 -08:00
Miss Islington (bot) f9ddbc0de5 GH-85979: Clarify specification of object.__await__ (GH-22320)
(cherry picked from commit f59c7f8edd)

Co-authored-by: Paolo Lammens <lammenspaolo@gmail.com>
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-12-30 22:34:12 -08:00
Miss Islington (bot) 1fa4c6bd1f gh-48496: Added example and link to faq for UnboundLocalError in reference (GH-93068)
(cherry picked from commit f3db68e6e6)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-12-22 15:30:12 -08:00
Miss Islington (bot) 138c2e6f3f [3.11] "Compound statement" docs: Fix with-statement step indexing (GH-100286) (GH-100300)
Back in commit 226e6e7d43
an item was added to the list, renumbering all the rest of the
items, but the forward-reference wasn't updated to match.
(cherry picked from commit f23236a92d)

Co-authored-by: Frank Dana <ferdnyc@gmail.com>
2022-12-16 11:01:24 -08:00
Miss Islington (bot) 0006d9bf7b Fix typo in __match_args__ doc (GH-99785)
A opy of GH-98549, whose author (@icecream17) uses a school computer that blocks the CLA site. I did not mention this in commit comment above so CLA bot does not pick up the name and request the CLA again.
(cherry picked from commit a86d854522)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-11-25 16:10:48 -08:00
Miss Islington (bot) 3dbf2708f5 doc: Formatting and typo fixes (GH-98974)
(cherry picked from commit 728e42fcf5)

Co-authored-by: jmcb <joelsgp@protonmail.com>
2022-11-07 09:14:52 -08:00
Miss Islington (bot) e0df94dc7c Docs: Add 'as, match statement' to the index (GH-99001)
(cherry picked from commit 26720fffd0)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-11-02 19:22:41 -07:00
Miss Islington (bot) 434943e0b4 [3.11] Python documents state elsewhere that a comma is not an operator (GH-98736) (#98757)
Python documents state elsewhere that a comma is not an operator, so calling it an operator here is confusing. See https://docs.python.org/3/reference/lexical_analysis.htmlGH-operators and https://docs.python.org/3/faq/programming.htmlGH-id22.
(cherry picked from commit d578aaea62)

Co-authored-by: Gerardwx <Gerardwx@users.noreply.github.com>
2022-10-28 12:15:34 +02:00
Stanley 5f86275ec2 [3.11] Change links to label refs (GH-98454) (#98725)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 268129a74f)
2022-10-26 13:18:50 -07:00