Commit Graph

895 Commits

Author SHA1 Message Date
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
Miss Islington (bot) 0bc2cf9915 gh-98172: [doc] mention that except* handles naked exceptions (GH-98496)
(cherry picked from commit 8367ca136e)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-10-21 03:43:56 -07:00
C.A.M. Gerlach ea19c28512 [3.11] Docs: Fix backtick errors found by sphinx-lint (GH-97998) (#98371)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>.
(cherry picked from commit fa2d43e518)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-10-18 01:49:38 +02:00
Miss Islington (bot) c0083e6470 gh-98227: executionmodel.rst: except* can also bind names (GH-98256)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 146f168fbf)

Co-authored-by: BiscuitCandy <70342294+BiscuitCandy@users.noreply.github.com>
2022-10-15 09:12:18 -07:00
Miss Islington (bot) 9b12084aca gh-98172: Fix formatting in except* docs (GH-98173)
(cherry picked from commit 5ecf961640)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-10-11 09:22:04 -07:00
Miss Islington (bot) 9828ccb63b gh-97913 Docs: Add walrus operator to the index (GH-97921)
* 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 296313002f)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-10-08 00:01:27 -07:00
Miss Islington (bot) ae2ab47820 [3.11] gh-97850: Remove the open issues section from the import reference (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 f8edc6ff53)


Co-authored-by: Brett Cannon <brett@python.org>

Automerge-Triggered-By: GH:brettcannon
2022-10-06 14:10:06 -07:00
Miss Islington (bot) 4aa2ebc01e gh-86482: Document assignment expression need for ()s (GH-23291)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 2b5f1360ea)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-10-06 12:32:39 -07:00
Łukasz Langa 83ad76275c [3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97924)
:c:type:`<C type>` -> :c:expr:`<C type>`

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 0031e62973)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-05 14:11:12 -07:00
Miss Islington (bot) 1fa848ac39 gh-95975: Move except/*/finally ref labels to more precise locations (GH-95976)
* 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 dcc82331c8)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-01 22:20:43 -07:00
Miss Islington (bot) 88ab19e47e Fix docs on conditional expression grouping (GH-96447) (GH-97606) 2022-09-28 08:45:48 -05:00
Miss Islington (bot) 9eb1e6c692 gh-96397: Document that keywords in calls need not be identifiers (GH-96393)
This represents the official SC stance, see
https://github.com/python/steering-council/issues/142GH-issuecomment-1252172695
(cherry picked from commit 9d432b4a18)

Co-authored-by: Jeff Allen <ja.py@farowl.co.uk>
2022-09-22 11:18:02 -07:00
Miss Islington (bot) ca7e78dc3a GH-96359: Fix docs that claim int(0|1) doesn't match False (GH-96361)
(cherry picked from commit 3d3a86ed40)

Co-authored-by: Jonathan Oberländer <github@l3vi.de>
2022-08-29 00:13:28 -07:00
Miss Islington (bot) f0469c7424 gh-95994: Clarify escaped newlines. (GH-96066)
* gh-95994: clarify escaped newlines.

* Rephrase ambiguous sentence.

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

* Use `<newline>` in escape sequences table.

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit c3d591fd06)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-08-26 12:11:59 -07:00
Serhiy Storchaka d8df7e0207 [3.11] gh-91838: Use HTTPS links in docs for resources which redirect to HTTPS (GH-95527) (GH-95643)
If an HTTP link is redirected to a same looking HTTPS link, the latter can
be used directly without changes in readability and behavior.
It protects from a men-in-the-middle attack.

This change does not affect Python examples..
(cherry picked from commit f79547a429)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-08-04 11:45:03 +03:00
Miss Islington (bot) e99496e1c2 Fix async method reference links in compound_stmts docs (GH-94935)
(cherry picked from commit 79d2f549ad)

Co-authored-by: July Tikhonov <july.tikh@gmail.com>
2022-07-22 10:13:02 -07:00
Miss Islington (bot) ccbf85382c gh-91181: drop support for bytes on sys.path (GH-31934)
Support for bytes broke sometime between Python 3.2 and 3.6 and has been broken ever since. Trying to bring back supports is surprisingly difficult in the face of -b and checking for keys in sys.path_importer_cache. Since the support was broken for so long, trying to overcome the difficulty of bringing back the support has been deemed not worth it.

Co-authored-by: Eryk Sun <eryksun@gmail.com>
Co-authored-by: Brett Cannon <brett@python.org>
(cherry picked from commit 6da988a46c)

Co-authored-by: Thomas Grainger <tagrain@gmail.com>
2022-07-16 18:31:25 -07:00