summaryrefslogtreecommitdiffstats
path: root/Doc/reference
Commit message (Collapse)AuthorAgeFilesLines
* [3.11] gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662) ↵Miss Islington (bot)2023-12-031-0/+2
| | | | | | | | (#112667) 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.11] gh-112331: Fix reference manual description of attribute lookup ↵Miss Islington (bot)2023-11-251-6/+12
| | | | mechanics (gh-112375) (gh-112413)
* [3.11] gh-111944: Add assignment expression parentheses requirements ↵Miss Islington (bot)2023-11-131-4/+5
| | | | | | | | | | (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 9a2f25d374f027f6509484d66e1c7bba03977b99) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* [3.11] GH-101100: Fix reference warnings for ``__enter__`` and ``__exit__`` ↵Miss Islington (bot)2023-10-192-13/+13
| | | | | | (GH-110112) (#111076) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] GH-101100: Fix reference warnings for ``__getitem__`` (GH-110118) ↵Miss Islington (bot)2023-10-192-4/+4
| | | | | | (#111074) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] gh-110886 Doc: add a link to BNF Wikipedia article (GH-110887) (#110901)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.11] gh-110631: Fix reST indentation in `Doc/reference` (GH-110708) (#110741)Ezio Melotti2023-10-124-76/+78
| | | | Fix wrong indentation in the Doc/reference dir.. (cherry picked from commit 41d8ec5a1bae1e5d4452da0a1a0649ace4ecb7b0)
* [3.11] gh-109634: Use :samp: role (GH-109635) (GH-109778)Serhiy Storchaka2023-09-291-42/+42
| | | | | (cherry picked from commit 92af0cc580051fd1129c7a86af2cbadeb2aa36dc) Co-authored-by: Jacob Coffee <jacob@z7x.org>
* [3.11] Datamodel: Add headings to the standard type hierarchy (GH-108146) ↵Adam Turner2023-08-251-981/+1085
| | | | | | | | | | | | (#108484) * [3.11] 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> * Fix indentation
* [3.11] Docs: Datamodel: Merge "Notes on using __slots__" with the parent ↵Miss Islington (bot)2023-08-251-2/+1
| | | | | | | section (GH-108400) (#108475) (cherry picked from commit 7f5b1a06612bf1454232ac634ad4d2c845f77b37) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386) ↵Miss Islington (bot)2023-07-293-6/+6
| | | | | | | (GH-107418) (cherry picked from commit f2d07d3289947d10b065b2bb7670c8fb6b6582f2) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.11] gh-106892: Use roles :data: and :const: for referencing module ↵Serhiy Storchaka2023-07-211-2/+2
| | | | | variables (GH-106894) (GH-106955) (cherry picked from commit d036db728ea3d54509cbad06df74e2d9a31fbec8)
* [3.11] gh-106919: Use role :c:macro: for referencing the C "constants" ↵Serhiy Storchaka2023-07-211-2/+2
| | | | | (GH-106920) (GH-106952) (cherry picked from commit fcc816dbff7ca66c26f57a506e4d2330fe41d0ff)
* [3.11] Replace the esoteric term 'datum' when describing dict comprehensions ↵Miss Islington (bot)2023-07-032-12/+12
| | | | | | | | (GH-106119) (#106349) Replace the esoteric term 'datum' when describing dict comprehensions (GH-106119) (cherry picked from commit 987b712b4aeeece336eed24fcc87a950a756c3e2) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* [3.11] Add single value `agen.athrow(value)` signature to the 3.11 docs ↵Federico Caselli2023-06-071-1/+2
| | | | gh-105269 (#105468)
* [3.11] GH-97950: Use new-style index directive ('builtin') (GH-104164) (#104221)Miss Islington (bot)2023-05-064-31/+31
| | | | | | | | | | | | | | | | | | 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 f5088006ca8e9654fbc3de119462f0ab764e408b) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] GH-97950: Use new-style index directive ('statement') (GH-104162) ↵Miss Islington (bot)2023-05-043-41/+41
| | | | | | (#104163) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] GH-97950: Use new-style index directive ('exception') (GH-104160) ↵Adam Turner2023-05-042-12/+12
| | | | (#104161)
* [3.11] GH-97950: Use new-style index directive ('object') (GH-104158) (#104159)Miss Islington (bot)2023-05-044-87/+87
| | | | | | | | | | | | | | | | 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 6ab463684b9d79880d98cd1f1406aa86af65985e) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] GH-97950: Use new-style index directive ('operator') (GH-104156) ↵Miss Islington (bot)2023-05-041-25/+25
| | | | | | (#104157) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] GH-97950: Use new-style index directive ('keyword') (GH-104153) (#104155)Miss Islington (bot)2023-05-043-27/+27
| | | | | | | | | | 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 33ca322c50baa5152afe388fb3b8b7d63dc5a9b9) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] GH-97950: Use new-style index directive ('module') (GH-103996) (#104154)Adam Turner2023-05-044-10/+10
|
* [3.11] gh-103590: do not wrap a single exception raised from a try-except* ↵Irit Katriel2023-05-021-0/+4
| | | | (#104094)
* [3.11] GH-103484: Fix redirected permanently URLs (GH-104001) (#104088)Rafael Fontenelle2023-05-022-2/+2
| | | | | | Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Oleg Iarygin <dralife@yandex.ru> Fix redirected permanently URLs (#104001)
* gh-103373: `__mro_entries__` docs: improve cross references (GH-103398)Miss Islington (bot)2023-04-111-5/+10
| | | | | | (cherry picked from commit e071f00aaefae9eccf787d5c50396c26c8616483) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* gh-103373: Improve documentation for `__mro_entries__` (GH-103374)Miss Islington (bot)2023-04-081-5/+9
| | | | | (cherry picked from commit 0ba0ca05d2b56afa0b055db02233e703fe138918) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* gh-100315: clarification to `__slots__` docs. (GH-102621)Miss Islington (bot)2023-03-141-2/+4
| | | | | | refer to tp_itemsize in discussion on "variable-length" built-in types (cherry picked from commit 88c262c086077377b40dfae5e46f597e28ffe3c9) Co-authored-by: T <tnie@tuta.io>
* [3.11] Fix duplicated words in the docs (#102644)Alex Waygood2023-03-131-1/+1
| | | | | | | (cherry-picked from commit f6ca71a422) With grep utility found some duplicated words Co-authored-by: Виталий Дмитриев <vitaldmit@bk.ru>
* gh-102011: use sys.exception() instead of sys.exc_info() in docs where ↵Miss Islington (bot)2023-02-212-18/+16
| | | | | | | possible (GH-102012) (cherry picked from commit 4d3bc89a3f54c4f09756a9b644b3912bf54191a7) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
* GH-101898: Fix missing term references for hashable definition (GH-101899)Miss Islington (bot)2023-02-141-1/+1
| | | | | | Fix missing term references for hashable definition (cherry picked from commit 3690688149dca11589af59b7704541336613199a) Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
* [3.11] gh-81611: Improve `range` paragraph in 8.3 of language reference ↵Miss Islington (bot)2023-01-041-3/+2
| | | | | | | | | | | (GH-98353) (#100704) gh-81611: Improve `range` paragraph in 8.3 of language reference (GH-98353) (cherry picked from commit 8b1f1251215651c4ef988622345c5cb134e54d69) 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>
* fix `grammer` -> `grammar` typo in expressions.rst (GH-100683)Miss Islington (bot)2023-01-021-1/+1
| | | | | | (cherry picked from commit 7feb6d2f85d69fbabfc0598d8947124883167f12) Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com> Automerge-Triggered-By: GH:AlexWaygood
* gh-100201: Document behavior with a bare `yield` statement (GH-100416)Miss Islington (bot)2023-01-011-1/+3
| | | | | | (cherry picked from commit 1aab269d4acbf0b29573ad0a21c54fddee233243) Co-authored-by: ram vikram singh <ramvikrams243@gmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* GH-85979: Clarify specification of `object.__await__` (GH-22320)Miss Islington (bot)2022-12-311-0/+8
| | | | | | (cherry picked from commit f59c7f8edd5ba5f6c1954383542a2292bcf51d91) Co-authored-by: Paolo Lammens <lammenspaolo@gmail.com> Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
* gh-48496: Added example and link to faq for UnboundLocalError in reference ↵Miss Islington (bot)2022-12-221-0/+2
| | | | | | | (GH-93068) (cherry picked from commit f3db68e6e66ebb36e1b9cb30daba913ecc736169) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* [3.11] "Compound statement" docs: Fix with-statement step indexing ↵Miss Islington (bot)2022-12-161-1/+1
| | | | | | | | | | (GH-100286) (GH-100300) Back in commit 226e6e7d4326cf91ef37e13528eb1f62de1bb832 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 f23236a92d8796ae91772adaf27c3485fda963e8) Co-authored-by: Frank Dana <ferdnyc@gmail.com>
* Fix typo in `__match_args__` doc (GH-99785)Miss Islington (bot)2022-11-261-1/+1
| | | | | | 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 a86d8545221b16e714ffe3bda5afafc1d4748d13) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* doc: Formatting and typo fixes (GH-98974)Miss Islington (bot)2022-11-072-5/+5
| | | | | (cherry picked from commit 728e42fcf51cbb2108caf1382df224c13b53d024) Co-authored-by: jmcb <joelsgp@protonmail.com>
* Docs: Add 'as, match statement' to the index (GH-99001)Miss Islington (bot)2022-11-031-0/+1
| | | | | (cherry picked from commit 26720fffd090929fd2058b73e5970cc520b30aef) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.11] Python documents state elsewhere that a comma is not an operator ↵Miss Islington (bot)2022-10-281-1/+1
| | | | | | | | (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 d578aaea6257458c199328100cbb5af64c6a043e) Co-authored-by: Gerardwx <Gerardwx@users.noreply.github.com>
* [3.11] Change links to label refs (GH-98454) (#98725)Stanley2022-10-261-0/+2
| | | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> (cherry picked from commit 268129a74f01adb7bb14cd71d1f38378e39d304d)
* gh-98172: [doc] mention that except* handles naked exceptions (GH-98496)Miss Islington (bot)2022-10-211-1/+13
| | | | | (cherry picked from commit 8367ca136ed7616cb1f71bd9f1ec98dbcfd35d98) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
* [3.11] Docs: Fix backtick errors found by sphinx-lint (GH-97998) (#98371)C.A.M. Gerlach2022-10-173-10/+2
| | | | | | | | Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>. (cherry picked from commit fa2d43e5184f5eaf3391844ec2400342a1b2ead4) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* gh-98227: executionmodel.rst: except* can also bind names (GH-98256)Miss Islington (bot)2022-10-151-1/+1
| | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 146f168fbf5b239158922f4defd494088c381525) Co-authored-by: BiscuitCandy <70342294+BiscuitCandy@users.noreply.github.com>
* gh-98172: Fix formatting in `except*` docs (GH-98173)Miss Islington (bot)2022-10-111-12/+11
| | | | | (cherry picked from commit 5ecf961640192a2192383aa20e1e93dcdf23c9b6) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* gh-97913 Docs: Add walrus operator to the index (GH-97921)Miss Islington (bot)2022-10-081-0/+6
| | | | | | | | | | | | | | | | | * Add walrus operator to the index * Add named expression to the index Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com> * Fix indentation and add missing newline Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> (cherry picked from commit 296313002fde56f52d6c81f17d7ba5c2eb57d098) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.11] gh-97850: Remove the open issues section from the import reference ↵Miss Islington (bot)2022-10-061-19/+0
| | | | | | | | | | | | | (GH-97935) (GH-97994) Remove the open issues section from the import reference Tracking in https://github.com/python/cpython/issues/97850 instead. (cherry picked from commit f8edc6ff531bb98858185857513371f14519ed1d) Co-authored-by: Brett Cannon <brett@python.org> Automerge-Triggered-By: GH:brettcannon
* gh-86482: Document assignment expression need for ()s (GH-23291)Miss Islington (bot)2022-10-061-0/+7
| | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 2b5f1360ead9aa72ae00de59edfd6c229d13933f) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* [3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C ↵Łukasz Langa2022-10-051-1/+1
| | | | | | | | | | type>) (GH-97768) (#97924) :c:type:`<C type>` -> :c:expr:`<C type>` Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit 0031e62973801d34a9e19ab7bb199e9668e32d7b) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* gh-95975: Move except/*/finally ref labels to more precise locations (GH-95976)Miss Islington (bot)2022-10-021-45/+76
| | | | | | | | | | | | | | | | | | | | | | * gh-95975: Move except/*/finally ref labels to more precise locations * Add section headers to fix :keyword: role and aid navigation * Move see also to the introduction rather than a particular subsection * Fix other minor Sphinx syntax issues with except Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> * Suppress redundant link to same section for except too * Don't link try/except/else/finally keywords if in the same section * Format try/except/finally as keywords in modified sections Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> (cherry picked from commit dcc82331c8f05a6a149ac15c519d4fbae72692b2) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>