summaryrefslogtreecommitdiffstats
path: root/Doc/reference
Commit message (Collapse)AuthorAgeFilesLines
* [3.12] Add information about negative indexes to sequence datamodel doc ↵Miss Islington (bot)2024-03-251-3/+6
| | | | | | | | (GH-110903) (#117238) Co-authored by Terry Jan Reedy (cherry picked from commit c2276176d543a2fc2d57709c2787f99850fbb073) Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
* [3.12] gh-56374: Clarify documentation of nonlocal (GH-116942) (#117023)Miss Islington (bot)2024-03-191-13/+17
| | | | | | | Define 'nonlocal scopes' in a way that excludes class scopes. Rearrange the rest of the doc. Add "Programmer's note". (cherry picked from commit 025ef7a5f7b424fba8713e448244b952bf897df3) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* [3.12] gh-107607: Update comment about utf-8 BOM being ignored (GH-107858) ↵Miss Islington (bot)2024-03-191-4/+3
| | | | | | (#117016) (cherry picked from commit 7f64ae30ddc22577ce4101ce0b6601b3548b036f) Co-authored-by: Terry Jan Reedy tjreedy@udel.edu
* [3.12] gh-116881: Remove erroneous or redundant grammar NULL (GH-116885) ↵Miss Islington (bot)2024-03-181-1/+1
| | | | | | | | | | | (#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 4e45c6c54a9457b1ca5b4cf3aa2843b7218d4414) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* [3.12] gh-115664: Fix ordering of more versionadded and versionchanged ↵Serhiy Storchaka2024-03-072-3/+1
| | | | | directives (GH-116298) (GH-116450) (cherry picked from commit 808a77612fb89b125d25efac2788522a100e8a6d)
* [3.12] gh-72971: Clarify the special no-TypeError behavior for equality ↵Miss Islington (bot)2024-03-031-1/+4
| | | | | | | (GH-110729) (#116254) (cherry picked from commit 67f742e03aacb6217c5bb496e31f96dbf31c6f86) Co-authored-by: Gouvernathor <44340603+Gouvernathor@users.noreply.github.com>
* [3.12] gh-104219: Document that idunders can return NotImplemented ↵Miss Islington (bot)2024-03-011-2/+4
| | | | | | | | | (GH-104220) (#116210) (cherry picked from commit 2713c2abc8d0f30cd0060cd307bb4ec92f1f04bf) 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>
* [3.12] Docs: mark up NotImplemented using the :data: role throughout the ↵Miss Islington (bot)2024-02-292-10/+10
| | | | | | | docs (GH-116135) (#116147) (cherry picked from commit dbe44f150cd161bd327ed662e527a4c93829fb3e) Co-authored-by: Erlend E. Aasland <erlend@python.org>
* [3.12] Erase some unnecessary quotes on data model doc (GH-113521) (#115896)Miss Islington (bot)2024-02-251-4/+4
| | | | | | | Thanks to Pedro Arthur Duarte (pedroarthur.jedi at gmail.com) for help with this bug. (cherry picked from commit f7455864f22369cc23bf3428624f310305cac999) Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
* [3.12] gh-115572: Move `codeobject.replace()` docs to the data model … ↵Kirill Podoprigora2024-02-181-0/+6
| | | | | | | | | | | | | | (#115633) * [3.12] gh-115572: Move `codeobject.replace()` docs to the data model (GH-115631) (cherry picked from commit 0c80da4c14d904a367968955544dd6ae58c8101c) 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>
* [3.12] gh-115405: add versionadded tag for co_qualname in code objects ↵Miss Islington (bot)2024-02-131-0/+2
| | | | | | | | documentation (GH-115411) (#115412) gh-115405: add versionadded tag for co_qualname in code objects documentation (GH-115411) (cherry picked from commit de07941729b8899b187b8ef9690f9a74b2d6286b) Co-authored-by: Christophe Papazian <114495376+christophe-papazian@users.noreply.github.com>
* [3.12] gh-114552: Update `__dir__` method docs: it allows returning an ↵Miss Islington (bot)2024-02-101-3/+3
| | | | | | | | iterable (GH-114662) (#115234) gh-114552: Update `__dir__` method docs: it allows returning an iterable (GH-114662) (cherry picked from commit e19103a346f0277c44a43dfaebad9a5aa468bf1e) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.12] Clarify one-item tuple (GH-114745) (#114757)Miss Islington (bot)2024-01-301-2/+3
| | | | | | | A 'single tuple' means 'one tuple, of whatever length. Remove the unneeded and slightly distracting parenthetical 'singleton' comment. (cherry picked from commit a1332a99cf1eb9b879d4b1f28761b096b5749a0d) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* [3.12] gh-101100: Fix sphinx warnings in `reference/import.rst` (GH-114646) ↵Miss Islington (bot)2024-01-271-3/+4
| | | | | | (#114652) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.12] gh-101100: Fix Sphinx warnings in `reference/expressions.rst` ↵Miss Islington (bot)2024-01-221-26/+26
| | | | | | (GH-114194) (#114436) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.12] Fix the confusing "User-defined methods" reference in the datamodel ↵Miss Islington (bot)2024-01-211-1/+1
| | | | (GH-114276) (#114365)
* [3.12] gh-114070: fix token reference warnings in expressions.rst ↵Miss Islington (bot)2024-01-171-2/+3
| | | | | | (GH-114169) (#114192) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
* [3.12] datamodel: Fix a typo in ``object.__init_subclass__`` (GH-111599) ↵Miss Islington (bot)2024-01-121-1/+1
| | | | | | | | (#114004) datamodel: Fix a typo in ``object.__init_subclass__`` (GH-111599) (cherry picked from commit a47353d587b78bb5501b21343d9bca739c49a43a) Co-authored-by: InSync <122007197+InSyncWithFoo@users.noreply.github.com>
* [3.12] Docs: Amend codeobject.co_lines docs; end number is exclusive ↵Miss Islington (bot)2024-01-121-3/+3
| | | | | | | | (GH-113970) (#113987) The end number should be exclusive, not inclusive. (cherry picked from commit e68806c7122070078507b370b13bb225f8501ff8) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* [3.12] gh-113664: Improve style of Big O notation (GH-113695) (GH-113909)Miss Islington (bot)2024-01-101-1/+1
| | | | | | Use cursive to make it looking like mathematic formulas. (cherry picked from commit a8629816c6c0e6770248a60529fd7c9ba08aad55) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.12] Document the `co_lines` method on code objects (#113682) (#113686)Alex Waygood2024-01-031-2/+37
| | | | | (cherry-picked from commit f1f839243251fef7422c31d6a7c3c747e0b5e27c) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.12] gh-81094: Refer to PEP 318 in compound_statements.rst (GH-113588) ↵Miss Islington (bot)2024-01-021-1/+4
| | | | | | | (#113643) Co-authored-by: John D. McDonald <43117960+Rasputin2@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.12] gh-113313: Note that slice support is not required for all sequences. ↵Miss Islington (bot)2023-12-211-3/+3
| | | | (gh-113377) (gh-113382)
* [3.12] Fix typo in datamodel docs (GH-113314) (#113316)Miss Islington (bot)2023-12-201-1/+1
| | | | | | Fix typo in datamodel docs (GH-113314) (cherry picked from commit 5a7cc667f816f0377f763322c2367301ea3379ee) Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
* [3.12] Docs: Add label to grammar spec for linking from PEPs (GH-113235) ↵Miss Islington (bot)2023-12-171-0/+2
| | | | | | (#113239) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.12] gh-101100: Fix Sphinx nitpicks in `library/inspect.rst` and ↵Miss Islington (bot)2023-12-141-3/+3
| | | | | | | | `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 4b3cb082da82da744f5db0b7315aa80558c51557) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-101100: Improve docs on exception attributes (GH-113057) (#113061)Miss Islington (bot)2023-12-132-9/+22
| | | | | | | gh-101100: Improve docs on exception attributes (GH-113057) (cherry picked from commit d05a180350fe20d5fde56c7e525e394a0b282703) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-101100: Further improve docs on function attributes (GH-113001) ↵Miss Islington (bot)2023-12-121-3/+6
| | | | | | | | (#113030) gh-101100: Further improve docs on function attributes (GH-113001) (cherry picked from commit 81a15ea74e2607728fceb822dfcc1aabff00478a) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-101100: Improve documentation on function attributes (GH-112933) ↵Hugo van Kemenade2023-12-122-93/+111
| | | | | | | (#112974) (cherry picked from commit 4c5b9c107a1d158b245f21a1839a2bec97d05383) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] Docs: Use 'f-strings' as header (GH-112888) (#112923)Miss Islington (bot)2023-12-101-2/+4
| | | | | | Docs: Use 'f-strings' as header (GH-112888) (cherry picked from commit 5bf7580d72259d7d64f5ee8cfc2df677de5310a4) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.12] gh-101100: Improve documentation of `TracebackType` attributes ↵Miss Islington (bot)2023-12-091-21/+39
| | | | | | | | (GH-112884) (#112911) gh-101100: Improve documentation of `TracebackType` attributes (GH-112884) (cherry picked from commit 96f64a2b1b4e3d4902848c63e42717a9c5539e03) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-101100: Improve documentation for attributes on instance methods ↵Miss Islington (bot)2023-12-081-25/+52
| | | | | | | | (GH-112832) (#112872) gh-101100: Improve documentation for attributes on instance methods (GH-112832) (cherry picked from commit ed21d0c1f4bd17b392e24bfd83e652723dad4ddf) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-101100: Improve documentation of code object attributes (#112781) ↵Alex Waygood2023-12-061-30/+84
| | | | | (#112816) (cherry-picked from commit e9707d3c3d)
* [3.12] gh-101100: Properly document frame object attributes (GH-112735) ↵Miss Islington (bot)2023-12-051-25/+59
| | | | | | | | (#112772) gh-101100: Properly document frame object attributes (GH-112735) (cherry picked from commit d109f637c048c2b5fc95dc7fdfd50f8ac41a7747) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-101100: Fix many easily solvable Sphinx nitpicks in the datamodel ↵Miss Islington (bot)2023-12-051-26/+32
| | | | | | | | docs (GH-112737) (#112748) gh-101100: Fix many easily solvable Sphinx nitpicks in the datamodel docs (GH-112737) (cherry picked from commit 2f20cafdbfc39925f9374f36f9d53bac365ed32a) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662) ↵Miss Islington (bot)2023-12-031-0/+2
| | | | | | | | (#112666) gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662) (cherry picked from commit 45650d1c479a8b0370f126d821718dd3c502f333) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-112331: Fix reference manual description of attribute lookup ↵Miss Islington (bot)2023-11-251-6/+12
| | | | mechanics (gh-112375) (#112412)
* [3.12] gh-111944: Add assignment expression parentheses requirements ↵Miss Islington (bot)2023-11-131-4/+5
| | | | | | | | | | (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 9a2f25d374f027f6509484d66e1c7bba03977b99) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* [3.12] Fix typos in import system docs (GH-111396) (#111397)Miss Islington (bot)2023-10-271-3/+3
| | | | | | Fix typos in import system docs (GH-111396) (cherry picked from commit 9a2f2f46caa556eae4c3ac3b45efa85bd91cc807) Co-authored-by: Jonathan Berthias <jvberthias@gmail.com>
* [3.12] GH-101100: Fix reference warnings for ``__enter__`` and ``__exit__`` ↵Miss Islington (bot)2023-10-192-13/+13
| | | | | | (GH-110112) (#111075) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] GH-101100: Fix reference warnings for ``__getitem__`` (GH-110118) ↵Miss Islington (bot)2023-10-192-4/+4
| | | | | | (#111073) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] gh-110886 Doc: add a link to BNF Wikipedia article (GH-110887) (#110900)Miss Islington (bot)2023-10-151-1/+2
| | | | | Co-authored-by: partev <petrosyan@gmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.12] gh-110631: Fix reST indentation in `Doc/reference` (GH-110708) (#110740)Miss Islington (bot)2023-10-114-77/+79
| | | | | | | | gh-110631: Fix reST indentation in `Doc/reference` (GH-110708) Fix wrong indentation in the Doc/reference dir. (cherry picked from commit 41d8ec5a1bae1e5d4452da0a1a0649ace4ecb7b0) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* [3.12] gh-109634: Fix `:samp:` syntax (GH-110073) (#110095)Miss Islington (bot)2023-09-291-1/+1
| | | | | | gh-109634: Fix `:samp:` syntax (GH-110073) (cherry picked from commit e27adc68ccee8345e05b7516e6b46f6c7ff53371) Co-authored-by: Jacob Coffee <jacob@z7x.org>
* [3.12] gh-109634: Use :samp: role (GH-109635) (#109776)Miss Islington (bot)2023-09-241-42/+42
| | | | | | gh-109634: Use :samp: role (GH-109635) (cherry picked from commit 92af0cc580051fd1129c7a86af2cbadeb2aa36dc) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.12] Docs: Resolve Sphinx warnings in dis.rst (GH-108476) (#108546)Miss Islington (bot)2023-08-271-1/+3
| | | | | | | | | | 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 cb1184280b3fb369a07abb4153aa36829cf1df9b) Co-authored-by: Erlend E. Aasland <erlend@python.org>
* [3.12] Docs: Datamodel: Merge "Notes on using __slots__" with the parent ↵Miss Islington (bot)2023-08-251-2/+1
| | | | | | | | section (GH-108400) (#108474) Docs: Datamodel: Merge "Notes on using __slots__" with the parent section (GH-108400) (cherry picked from commit 7f5b1a06612bf1454232ac634ad4d2c845f77b37) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] Datamodel: Add headings to the standard type hierarchy (GH-108146) ↵Miss Islington (bot)2023-08-251-1000/+1104
| | | | | | | | | | (#108477) Datamodel: Add headings to the standard type hierarchy (GH-108146) Dedent content according to the new layout. (cherry picked from commit 2b7bff0655a4caf51cd1a9e5bf85b3b96dd031c9) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386) ↵Serhiy Storchaka2023-07-293-6/+6
| | | | | (GH-107419) (cherry picked from commit f2d07d3289947d10b065b2bb7670c8fb6b6582f2)
* [3.12] gh-102111: Add link to string escape sequences in re module ↵Miss Islington (bot)2023-07-231-0/+4
| | | | | | | (GH-106995) (#107096) Co-authored-by: wulmer <wulmer@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>