Commit graph

957 commits

Author SHA1 Message Date
Miss Islington (bot)
4d85f0ae76
[3.12] Clarifying nonlocal doc: SyntaxError is raised if nearest enclosing scope is global (GH-114009) (#118128)
Clarifying nonlocal doc: SyntaxError is raised if nearest enclosing scope is global (GH-114009)
(cherry picked from commit 1558d99316)

Co-authored-by: Quazi Irfan <quazirfan@gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-04-21 01:50:01 +00:00
Hugo van Kemenade
a844e83b06
[3.12] Add 'The Python 2.3 Method Resolution Order' (GH-116435) (#117885)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-04-15 14:14:16 +03:00
Miss Islington (bot)
9359fdd6fa
[3.12] Add information about negative indexes to sequence datamodel doc (GH-110903) (#117238)
Co-authored by Terry Jan Reedy
(cherry picked from commit c2276176d5)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2024-03-25 22:40:28 +00:00
Miss Islington (bot)
05b2b30436
[3.12] gh-56374: Clarify documentation of nonlocal (GH-116942) (#117023)
Define 'nonlocal scopes' in a way that excludes class scopes.
Rearrange the rest of the doc.  Add "Programmer's note".

(cherry picked from commit 025ef7a5f7)
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-03-19 18:05:27 +00:00
Miss Islington (bot)
1627c1ee01
[3.12] gh-107607: Update comment about utf-8 BOM being ignored (GH-107858) (#117016)
(cherry picked from commit 7f64ae30dd)
Co-authored-by: Terry Jan Reedy tjreedy@udel.edu
2024-03-19 12:00:40 -04:00
Miss Islington (bot)
6383b14957
[3.12] gh-116881: Remove erroneous or redundant grammar NULL (GH-116885) (#116951)
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:26 -04:00
Serhiy Storchaka
1e75fe1468
[3.12] gh-115664: Fix ordering of more versionadded and versionchanged directives (GH-116298) (GH-116450)
(cherry picked from commit 808a77612f)
2024-03-07 08:21:25 +00:00
Miss Islington (bot)
5b73ed4b66
[3.12] gh-72971: Clarify the special no-TypeError behavior for equality (GH-110729) (#116254)
(cherry picked from commit 67f742e03a)

Co-authored-by: Gouvernathor <44340603+Gouvernathor@users.noreply.github.com>
2024-03-03 01:55:59 +01:00
Miss Islington (bot)
694874b7dc
[3.12] gh-104219: Document that idunders can return NotImplemented (GH-104220) (#116210)
(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:08:59 +00:00
Miss Islington (bot)
240e5f613b
[3.12] Docs: mark up NotImplemented using the :data: role throughout the docs (GH-116135) (#116147)
(cherry picked from commit dbe44f150c)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-02-29 20:53:51 +00:00
Miss Islington (bot)
59ec6e8f23
[3.12] Erase some unnecessary quotes on data model doc (GH-113521) (#115896)
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:14 -05:00
Kirill Podoprigora
ae6c01d9d2
[3.12] gh-115572: Move codeobject.replace() docs to the data model … (#115633)
* [3.12] 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:38:33 +00:00
Miss Islington (bot)
c2a3c3c643
[3.12] gh-115405: add versionadded tag for co_qualname in code objects documentation (GH-115411) (#115412)
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)
7cc205872d
[3.12] gh-114552: Update __dir__ method docs: it allows returning an iterable (GH-114662) (#115234)
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:50:31 +00:00
Miss Islington (bot)
b3d01fc56d
[3.12] Clarify one-item tuple (GH-114745) (#114757)
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:28 +00:00
Miss Islington (bot)
01910d6845
[3.12] gh-101100: Fix sphinx warnings in reference/import.rst (GH-114646) (#114652)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-01-27 09:37:08 -07:00
Miss Islington (bot)
f9979212f8
[3.12] gh-101100: Fix Sphinx warnings in reference/expressions.rst (GH-114194) (#114436)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-22 18:50:20 +02:00
Miss Islington (bot)
f7d5d936ab
[3.12] Fix the confusing "User-defined methods" reference in the datamodel (GH-114276) (#114365) 2024-01-21 03:52:04 +00:00
Miss Islington (bot)
74a6b7f639
[3.12] gh-114070: fix token reference warnings in expressions.rst (GH-114169) (#114192)
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-01-17 16:46:02 +00:00
Miss Islington (bot)
d577225104
[3.12] datamodel: Fix a typo in `object.__init_subclass__` (GH-111599) (#114004)
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:05:48 +00:00
Miss Islington (bot)
eb22afb004
[3.12] Docs: Amend codeobject.co_lines docs; end number is exclusive (GH-113970) (#113987)
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:43 +00:00
Miss Islington (bot)
082998c3af
[3.12] gh-113664: Improve style of Big O notation (GH-113695) (GH-113909)
Use cursive to make it looking like mathematic formulas.
(cherry picked from commit a8629816c6)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-01-10 13:08:08 +00:00
Alex Waygood
d3f2051eec
[3.12] Document the co_lines method on code objects (#113682) (#113686)
(cherry-picked from commit f1f8392432)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2024-01-03 20:09:15 +00:00
Miss Islington (bot)
3b5c2da079
[3.12] gh-81094: Refer to PEP 318 in compound_statements.rst (GH-113588) (#113643)
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:46:01 +00:00
Miss Islington (bot)
08d3b5dd30
[3.12] gh-113313: Note that slice support is not required for all sequences. (gh-113377) (gh-113382) 2023-12-21 22:00:52 +00:00
Miss Islington (bot)
44101e9cd3
[3.12] Fix typo in datamodel docs (GH-113314) (#113316)
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:05:33 +00:00
Miss Islington (bot)
38a41820ee
[3.12] Docs: Add label to grammar spec for linking from PEPs (GH-113235) (#113239)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-17 19:30:10 +00:00
Miss Islington (bot)
dc568dd226
[3.12] gh-101100: Fix Sphinx nitpicks in library/inspect.rst and reference/simple_stmts.rst (GH-113107) (#113109)
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:47 +00:00
Miss Islington (bot)
34714f4ac9
[3.12] gh-101100: Improve docs on exception attributes (GH-113057) (#113061)
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
Miss Islington (bot)
e328115254
[3.12] gh-101100: Further improve docs on function attributes (GH-113001) (#113030)
gh-101100: Further improve docs on function attributes (GH-113001)
(cherry picked from commit 81a15ea74e)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-12 20:28:10 +00:00
Hugo van Kemenade
54fcfbde30
[3.12] gh-101100: Improve documentation on function attributes (GH-112933) (#112974)
(cherry picked from commit 4c5b9c107a)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-12 10:10:27 +00:00
Miss Islington (bot)
81c2df0f8b
[3.12] Docs: Use 'f-strings' as header (GH-112888) (#112923)
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:01 +02:00
Miss Islington (bot)
b23034de9d
[3.12] gh-101100: Improve documentation of TracebackType attributes (GH-112884) (#112911)
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:33 +00:00
Miss Islington (bot)
b39e90e4d1
[3.12] gh-101100: Improve documentation for attributes on instance methods (GH-112832) (#112872)
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:52 +00:00
Alex Waygood
ca11aec98c
[3.12] gh-101100: Improve documentation of code object attributes (#112781) (#112816)
(cherry-picked from commit e9707d3c3d)
2023-12-06 22:11:53 +00:00
Miss Islington (bot)
ef92e9e666
[3.12] gh-101100: Properly document frame object attributes (GH-112735) (#112772)
gh-101100: Properly document frame object attributes (GH-112735)
(cherry picked from commit d109f637c0)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-05 19:34:06 +00:00
Miss Islington (bot)
68f05dd829
[3.12] gh-101100: Fix many easily solvable Sphinx nitpicks in the datamodel docs (GH-112737) (#112748)
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:11 +00:00
Miss Islington (bot)
5608112fa9
[3.12] gh-101100: Fix most Sphinx nitpicks in inspect.rst (GH-112662) (#112666)
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:26 +00:00
Miss Islington (bot)
b478c5e50c
[3.12] gh-112331: Fix reference manual description of attribute lookup mechanics (gh-112375) (#112412) 2023-11-25 22:26:31 +00:00
Miss Islington (bot)
3b7e308a24
[3.12] gh-111944: Add assignment expression parentheses requirements (GH-111977) (#112010)
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:17:54 +00:00
Miss Islington (bot)
2014c23de3
[3.12] Fix typos in import system docs (GH-111396) (#111397)
Fix typos in import system docs (GH-111396)
(cherry picked from commit 9a2f2f46ca)

Co-authored-by: Jonathan Berthias <jvberthias@gmail.com>
2023-10-27 13:29:55 +00:00
Miss Islington (bot)
91a6e98e92
[3.12] GH-101100: Fix reference warnings for `__enter__ and __exit__` (GH-110112) (#111075)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-10-19 18:34:25 +03:00
Miss Islington (bot)
cdcab408a0
[3.12] GH-101100: Fix reference warnings for `__getitem__` (GH-110118) (#111073)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-10-19 18:33:03 +03:00
Miss Islington (bot)
97f4b667e7
[3.12] gh-110886 Doc: add a link to BNF Wikipedia article (GH-110887) (#110900)
Co-authored-by: partev <petrosyan@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-15 17:00:44 +00:00
Miss Islington (bot)
dbbe0eebf0
[3.12] gh-110631: Fix reST indentation in Doc/reference (GH-110708) (#110740)
gh-110631: Fix reST indentation in `Doc/reference` (GH-110708)

Fix wrong indentation in the Doc/reference dir.
(cherry picked from commit 41d8ec5a1b)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-10-11 23:13:21 +02:00
Miss Islington (bot)
8882b30dab
[3.12] gh-109634: Fix :samp: syntax (GH-110073) (#110095)
gh-109634: Fix `:samp:` syntax (GH-110073)
(cherry picked from commit e27adc68cc)

Co-authored-by: Jacob Coffee <jacob@z7x.org>
2023-09-29 15:31:10 +02:00
Miss Islington (bot)
2622b13046
[3.12] gh-109634: Use :samp: role (GH-109635) (#109776)
gh-109634: Use :samp: role (GH-109635)
(cherry picked from commit 92af0cc580)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-09-24 13:54:36 +02:00
Miss Islington (bot)
311fd96dae
[3.12] Docs: Resolve Sphinx warnings in dis.rst (GH-108476) (#108546)
Docs: Resolve Sphinx warnings in dis.rst (GH-108476)

- Link to the code objects reference
- Suppress link to deliberately undocumented builtins.__build_class__
- Suppress links for example methods
(cherry picked from commit cb1184280b)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-08-28 01:59:35 +02:00
Miss Islington (bot)
ce37fbc778
[3.12] Docs: Datamodel: Merge "Notes on using __slots__" with the parent section (GH-108400) (#108474)
Docs: Datamodel: Merge "Notes on using __slots__" with the parent section (GH-108400)
(cherry picked from commit 7f5b1a0661)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-25 18:23:11 +02:00
Miss Islington (bot)
334da81992
[3.12] Datamodel: Add headings to the standard type hierarchy (GH-108146) (#108477)
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>
2023-08-25 18:22:45 +02:00