Commit graph

938 commits

Author SHA1 Message Date
Miss Islington (bot)
851821d871
[3.11] gh-100117: Fix inaccuracy in documentation of the CodeObject's co_positions field. (GH-119364) (#119871)
(cherry picked from commit 015b1fdd0a)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2024-09-04 18:06:13 +02:00
Miss Islington (bot)
e64c7d3e19
[3.11] Add information about negative indexes to sequence datamodel doc (GH-110903) (#117239)
Co-authored by Terry Jan Reedy
(cherry picked from commit c2276176d5)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2024-03-25 22:40:41 +00:00
Miss Islington (bot)
bb7a6d4707
[3.11] gh-107607: Update comment about utf-8 BOM being ignored (GH-107858) (#117015)
(cherry picked from commit 7f64ae30dd)
Co-authored-by: Terry Jan Reedy tjreedy@udel.edu
2024-03-19 11:59:52 -04:00
Miss Islington (bot)
56cd8740a0
[3.11] gh-116881: Remove erroneous or redundant grammar NULL (GH-116885) (#116952)
In Lexical Analysis f-strings section, NULL in the description
of 'literal character' means '\0'.  In the format_spec grammar
production, it is wrong with that meaning and redundant if
instead interpreted as <nothing>.  Remove it there.
(cherry picked from commit 4e45c6c54a)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-03-18 10:37:42 -04:00
Serhiy Storchaka
e89f2a0be1
[3.11] gh-115664: Fix ordering of more versionadded and versionchanged directives (GH-116298) (GH-116450) (GH-116452)
(cherry picked from commit 1e75fe1468)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
(cherry picked from commit 808a77612f)
2024-03-07 08:35:24 +00:00
Miss Islington (bot)
82e7692ca6
[3.11] gh-72971: Clarify the special no-TypeError behavior for equality (GH-110729) (#116255)
(cherry picked from commit 67f742e03a)

Co-authored-by: Gouvernathor <44340603+Gouvernathor@users.noreply.github.com>
2024-03-03 01:56:19 +01:00
Miss Islington (bot)
9eb7ed7121
[3.11] gh-104219: Document that idunders can return NotImplemented (GH-104220) (#116211)
(cherry picked from commit 2713c2abc8)

Co-authored-by: Gouvernathor <44340603+Gouvernathor@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-03-01 16:09:02 +00:00
Miss Islington (bot)
f4efc135b3
[3.11] Docs: mark up NotImplemented using the :data: role throughout the docs (GH-116135) (#116148)
(cherry picked from commit dbe44f150c)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-02-29 20:53:50 +00:00
Miss Islington (bot)
92e43aea35
[3.11] Erase some unnecessary quotes on data model doc (GH-113521) (#115897)
Thanks to Pedro Arthur Duarte (pedroarthur.jedi at gmail.com) for help with this bug.

(cherry picked from commit f7455864f2)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2024-02-24 23:30:34 -05:00
Kirill Podoprigora
c69da47ac9
[3.11] gh-115572: Move codeobject.replace() docs to the data model … (#115632)
* [3.11] gh-115572: Move `codeobject.replace()` docs to the data model (GH-115631)
(cherry picked from commit 0c80da4c14)

Co-authored-by: Daler <48939169+daler-sz@users.noreply.github.com>

* Remove note about copy.replace

---------

Co-authored-by: Daler <48939169+daler-sz@users.noreply.github.com>
2024-02-18 14:37:27 +00:00
Miss Islington (bot)
0af16e3dc6
[3.11] gh-115405: add versionadded tag for co_qualname in code objects documentation (GH-115411) (#115413)
gh-115405: add versionadded tag for co_qualname in code objects documentation (GH-115411)
(cherry picked from commit de07941729)

Co-authored-by: Christophe Papazian <114495376+christophe-papazian@users.noreply.github.com>
2024-02-13 16:16:22 +00:00
Miss Islington (bot)
089cae5158
[3.11] gh-114552: Update __dir__ method docs: it allows returning an iterable (GH-114662) (#115235)
gh-114552: Update `__dir__` method docs: it allows returning an iterable (GH-114662)
(cherry picked from commit e19103a346)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-02-10 08:54:43 +00:00
Miss Islington (bot)
df5381d8b6
[3.11] gh-103360: Add link in stdtypes.rst to escape sequences in lexical_analysis.rst (GH-103638) (#114908)
(cherry picked from commit d29f57f603)

Co-authored-by: Justin Williams <97240811+juswil@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-02-02 21:06:35 +00:00
Miss Islington (bot)
f1f0f2e3d7
[3.11] Clarify one-item tuple (GH-114745) (#114758)
A 'single tuple' means 'one tuple, of whatever length.
Remove the unneeded and slightly distracting parenthetical 'singleton' comment.
(cherry picked from commit a1332a99cf)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-01-30 18:50:32 +00:00
Nikita Sobolev
27ccb7e1ae
[3.11] gh-101100: Fix sphinx warnings in reference/import.rst (GH-114646) (#114654) 2024-01-27 09:37:13 -07:00
Miss Islington (bot)
350b4c7c0c
[3.11] gh-101100: Fix Sphinx warnings in reference/expressions.rst (GH-114194) (#114437)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-22 18:50:28 +02:00
Miss Islington (bot)
3681effafb
[3.11] Fix the confusing "User-defined methods" reference in the datamodel (GH-114276) (#114366) 2024-01-21 03:52:30 +00:00
Miss Islington (bot)
654c70a655
[3.11] gh-114070: fix token reference warnings in expressions.rst (GH-114169) (#114193)
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-01-17 18:53:08 +02:00
Miss Islington (bot)
cd8fd2292e
[3.11] datamodel: Fix a typo in `object.__init_subclass__` (GH-111599) (#114005)
datamodel: Fix a typo in ``object.__init_subclass__`` (GH-111599)
(cherry picked from commit a47353d587)

Co-authored-by: InSync <122007197+InSyncWithFoo@users.noreply.github.com>
2024-01-12 23:06:14 +00:00
Miss Islington (bot)
f8dd29030d
[3.11] Docs: Amend codeobject.co_lines docs; end number is exclusive (GH-113970) (#113988)
The end number should be exclusive, not inclusive.
(cherry picked from commit e68806c712)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2024-01-12 15:10:33 +00:00
Serhiy Storchaka
c92a473a71
[3.11] gh-113664: Improve style of Big O notation (GH-113695) (GH-113910)
Use cursive to make it looking like mathematic formulas.
(cherry picked from commit a8629816c6)
2024-01-10 13:13:27 +00:00
Alex Waygood
c828dbc196
[3.11] Document the co_lines method on code objects (#113682) (#113687)
(cherry-picked from commit f1f8392432)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2024-01-03 19:59:10 +00:00
Miss Islington (bot)
f8b61c739b
[3.11] gh-81094: Refer to PEP 318 in compound_statements.rst (GH-113588) (#113644)
Co-authored-by: John D. McDonald <43117960+Rasputin2@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2024-01-02 08:45:51 +00:00
Miss Islington (bot)
beb1c6506c
[3.11] gh-113313: Note that slice support is not required for all sequences. (gh-113377) (gh-113383) 2023-12-21 22:01:25 +00:00
Miss Islington (bot)
899f1c082c
[3.11] Fix typo in datamodel docs (GH-113314) (#113315)
Fix typo in datamodel docs (GH-113314)
(cherry picked from commit 5a7cc667f8)

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2023-12-20 12:04:59 +00:00
Miss Islington (bot)
559951304f
[3.11] Docs: Add label to grammar spec for linking from PEPs (GH-113235) (#113240)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-17 19:29:23 +00:00
Miss Islington (bot)
3b7b256053
[3.11] gh-101100: Fix Sphinx nitpicks in library/inspect.rst and reference/simple_stmts.rst (GH-113107) (#113110)
gh-101100: Fix Sphinx nitpicks in `library/inspect.rst` and `reference/simple_stmts.rst` (GH-113107)
(cherry picked from commit 4b3cb082da)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-14 13:37:38 +00:00
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