summaryrefslogtreecommitdiffstats
path: root/Doc/reference
Commit message (Collapse)AuthorAgeFilesLines
* 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.10] Fix duplicated words in the docs (#102645)Alex Waygood2023-03-131-1/+1
| | | | | | | (cherry-picked from commit f6ca71a) With grep utility found some duplicated words Co-authored-by: Виталий Дмитриев <vitaldmit@bk.ru>
* 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.10] gh-81611: Improve `range` paragraph in 8.3 of language reference ↵Miss Islington (bot)2023-01-041-3/+2
| | | | | | | | | | | (GH-98353) (#100705) 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>
* "Compound statement" docs: Fix with-statement step indexing (GH-100286)Miss Islington (bot)2022-12-161-1/+1
| | | | | | | | 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.10] Change links to label refs (GH-98454) (#98726)Stanley2022-10-261-0/+2
| | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* [3.10] Docs: Fix backtick errors found by sphinx-lint (GH-97998) (#98373)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-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>
* gh-97850: Remove the open issues section from the import reference (GH-97935)Miss Islington (bot)2022-10-061-19/+0
| | | | | | | | 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>
* 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.10] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C ↵Łukasz Langa2022-10-051-1/+1
| | | | | | | | | | | type>) (GH-97768) (#97925) :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-96397: Document that keywords in calls need not be identifiers (GH-96393)Miss Islington (bot)2022-09-221-2/+12
| | | | | | | This represents the official SC stance, see https://github.com/python/steering-council/issues/142GH-issuecomment-1252172695 (cherry picked from commit 9d432b4a181cd42017699de4354e7b36c5b87d88) Co-authored-by: Jeff Allen <ja.py@farowl.co.uk>
* GH-96359: Fix docs that claim int(0|1) doesn't match False (GH-96361)Miss Islington (bot)2022-08-291-1/+1
| | | | | (cherry picked from commit 3d3a86ed40626471b2c9e7f1336b228eb0dd0879) Co-authored-by: Jonathan Oberländer <github@l3vi.de>
* [3.10] gh-95994: Clarify escaped newlines. (GH-96066) (#96360)Ezio Melotti2022-08-281-11/+21
| | | | | | | | | | | | | | | | * 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 c3d591fd0699605c8253beda2372114052a7bdba) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* [3.10] gh-91838: Use HTTPS links in docs for resources which redirect to ↵Serhiy Storchaka2022-08-041-3/+3
| | | | | | | | | | | | HTTPS (GH-95527) (GH-95644) 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 f79547a429d5c90af83a0da821e082cba20d4712) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* Fix async method reference links in `compound_stmts` docs (GH-94935)Miss Islington (bot)2022-07-221-2/+2
| | | | | (cherry picked from commit 79d2f549adcbbefd4f2c0a0c9dd572bbbf252c62) Co-authored-by: July Tikhonov <july.tikh@gmail.com>
* [3.10] Docs: remove redundant "adverb-adjective" hyphens from compound ↵Łukasz Langa2022-07-053-4/+4
| | | | | | | | modifiers (GH-94551) (GH-94558) Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021 (cherry picked from commit 3440d197a55800ecceea3e115e44b4262411359c) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* [3.10] gh-93675: Fix typos in `Doc/` (GH-93676) (GH-94080)Łukasz Langa2022-06-211-1/+1
| | | | | | Closes GH-93675 (cherry picked from commit 830513754d081619b2d72db17770627312072fa5) Co-authored-by: luzpaz <luzpaz@users.noreply.github.com>
* bpo-45393: help() on operator precedence has misleading entries (GH-31246) ↵Miss Islington (bot)2022-05-191-2/+2
| | | | | | | (GH-92966) (cherry picked from commit fb082c2fc5a925085b179e63ca10b7f60b356d2f) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* gh-80143: Add clarification for escape characters (GH-92292) (GH-92629)Miss Islington (bot)2022-05-161-3/+7
| | | | | (cherry picked from commit 549567c6e70da4846c105a18a1a89e7dd09680d7) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* gh-87304: Improve comments in language reference for imports (GH-92164)Miss Islington (bot)2022-05-031-3/+3
| | | | | (cherry picked from commit ee2205b208389611e8a278ac1bc74b34f4994fd2) Co-authored-by: Robert Yang <35813883+robert861212@users.noreply.github.com>
* gh-89885: Improve import example in language reference (GH-91523)Miss Islington (bot)2022-04-171-6/+4
| | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit d5a69571f586080af4c29671c47f9c4bc671af7f) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* Language reference: Remove duplicated text about iterable unpacking (GH-25212)Miss Islington (bot)2022-04-031-3/+1
| | | | | (cherry picked from commit 4f5d56f8f33196f5ed8ffad0ab2f012afda2f9b3) Co-authored-by: Jiashuo Li <4003950+jiasli@users.noreply.github.com>
* bpo-24563: Link encoding names to encoding declarations (GH-32274)Miss Islington (bot)2022-04-031-3/+2
| | | | | (cherry picked from commit 01be5d6446abbdd95d0c18bd19a58a62b05568d8) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* bpo-14911: Corrected generator.throw() documentation (GH-32207)Miss Islington (bot)2022-03-312-3/+17
| | | | | | Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com> (cherry picked from commit 8be7c2bc5ad5e295f0f855bb31db412eef2c7c92) Co-authored-by: Dave Goncalves <davegoncalves@gmail.com>
* bpo-12029: [doc] clarify that except does not match virtual subclasses of ↵Irit Katriel2022-03-212-5/+7
| | | | | the specified exception type (GH-32027) (GH-32034) (cherry picked from commit 45833b50f0ccf2abb01304c900afee05b6d01b9e)
* bpo-46013: Fix confusing kerning on period in docs (GH-29989) (GH-32005)Miss Islington (bot)2022-03-201-1/+1
| | | | | | | (cherry picked from commit 3af68fc77c528d4e7749046cf6e41fd79902e6e6) Co-authored-by: jmcb <joel.mcbride1@live.com> Co-authored-by: jmcb <joel.mcbride1@live.com>
* Removed confusing reference to sys (GH-31638)Miss Islington (bot)2022-03-081-3/+3
| | | | | (cherry picked from commit 28f84c72b6cee145f9c00e9b999656e9a2517e49) Co-authored-by: David Gilbertson <gilbertson.david@gmail.com>
* Removed ambiguity in __init_subclass__ docs (GH-31540)Miss Islington (bot)2022-03-081-1/+1
| | | | | (cherry picked from commit ab014978aef303ac60465c9010505d798dc34df8) Co-authored-by: David Gilbertson <gilbertson.david@gmail.com>
* bpo-45680: Improve docs on subscriptions w.r.t. `GenericAlias` objects ↵Miss Islington (bot)2022-03-081-20/+30
| | | | | | | (GH-29479) (cherry picked from commit 50731297a9b6d57eec3b3f89522785b23f7b3e71) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.10] bpo-23556: [doc] Fix inaccuracy in documentation for raise without ↵Miss Islington (bot)2022-01-271-8/+10
| | | | | | | | | | args. Improve tests for context in nested except handlers. (GH-29236) (GH-30953) (cherry picked from commit 08c0ed2d9c0d01ad1a5adc0787bc75e4e90cbb85) Co-authored-by: Kinshuk Dua <kinshukdua@gmail.com> Automerge-Triggered-By: GH:iritkatriel
* [3.10] bpo-24650: Use full term "generator function" in yield expressions ↵Miss Islington (bot)2022-01-071-2/+2
| | | | | | | | | | docs (GH-24663) (GH-30461) (cherry picked from commit 273cb8e7577d143830404f6779946a0bedb58758) Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com> Automerge-Triggered-By: GH:iritkatriel
* bpo-46095: Improve SeqIter documentation. (GH-30316) (GH-30330)Miss Islington (bot)2022-01-011-21/+0
|
* bpo-46076: Improve documentation for per-attribute docstrings with ↵Miss Islington (bot)2021-12-191-3/+6
| | | | `__slots__` (GH-30109) (GH-30206)
* bpo-45840: Improve cross-references in the data model documentation ↵Alex Waygood2021-12-131-54/+76
| | | | | (GH-29633) (GH-30077) (cherry picked from commit c0521fe49fd75e794a38a216813658ab40185834)
* [doc] Clarify MRO precedence in descriptor super binding section (GH-29539) ↵Miss Islington (bot)2021-12-111-1/+1
| | | | | | | | | (GH-29669) A similar sentence is present in the 'Invocation from super' section of the descriptor HOWTO, where it is already correct. (cherry picked from commit ee49484c0f0d0d79e8fc40835da10b78f89ae503) Co-authored-by: Jouke Witteveen <j.witteveen@gmail.com>
* bpo-45619: documentation of execution model: clarify and update binding ↵Miss Islington (bot)2021-11-261-9/+19
| | | | | | | | | | | | | summary (GH-29232) This does two changes that are quite related. 0. it add that variable binding can occur in pattern matching, an update of 3.10 which seems to have been omitted from the list of bindings 1. Given how long the sentence already was, with even subcases in the middle of the sentence, the commit breaks the sentence into an actual list. (cherry picked from commit cd876c84932ecc2f7a6c41f3fc800a34d5b06b95) Co-authored-by: Arthur Milchior <arthur@milchior.fr>
* [3.10] bpo-45250: fix docs regarding `__iter__` and iterators being ↵Brett Cannon2021-11-221-14/+12
| | | | | | | | inconsistently required by CPython (GH-29170) (GH-29650) It is now considered a historical accident that e.g. `for` loops and the `iter()` built-in function do not require the iterators they work with to define `__iter__`, only `__next__`. (cherry picked from commit be36e0634060c7d5dee8e8876fb888bbb53d992a) Co-authored-by: Brett Cannon <brett@python.org>
* [3.10] [doc] bpo-45680: Disambiguate ``__getitem__`` and ↵Miss Islington (bot)2021-11-181-18/+146
| | | | | | | | | | | | | | | | | ``__class_getitem__`` in the data model (GH-29389) (GH-29620) The documentation explaining Python's data model does not adequately explain the differences between ``__getitem__`` and ``__class_getitem__``, nor does it explain when each is called. There is an attempt at explaining ``__class_getitem__`` in the documentation for ``GenericAlias`` objects, but this does not give sufficient clarity into how the method works. Moreover, it is the wrong place for that information to be found; the explanation of ``__class_getitem__`` should be in the documentation explaining the data model. This PR has been split off from GH-29335. (cherry picked from commit 31b3a70edb1216bdc8fab3b2eafd8ddb00487f41) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* bpo-45640: [docs] Tokens are now clickable (GH-29260) (GH-29621)Miss Islington (bot)2021-11-183-53/+53
| | | | | | Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit 32959108f9c543e3cb9f2b68bbc782bddded6f42) Co-authored-by: Arthur Milchior <arthur@milchior.fr>
* bpo-45583: Correct datamodel documentation of int() (GH-29182) (GH-29285)Miss Islington (bot)2021-10-281-2/+2
| | | | | | | It should be noted that this part of the documentation is redundant with function.rst's documentation of int. This one was correctly updated with Python 3.8. (cherry picked from commit d9c1868c25ec6466e8d8ae21fe9315a8a03836ab) Co-authored-by: Arthur Milchior <arthur@milchior.fr>
* [3.10]bpo-45463: Clarify that global statements allows multiple names ↵Miss Islington (bot)2021-10-161-4/+4
| | | | | | | | | | | | | | (GH-28851) (GH-28989) The global statement allows specifying a list of identifiers (https://docs.python.org/3/reference/simple_stmts.htmlGH-the-global-statement). The "Execution model" chapter described the global statement as if it only allowed one single name. Pluralize "name" in the appropriate places. (cherry picked from commit 4ecd119b007cb766b8bede2dc78b70d29cd932dd) Co-authored-by: Luca Chiodini <luca@chiodini.org> Co-authored-by: Luca Chiodini <luca@chiodini.org>
* [docs] lexical_analysis: Expand the text on ``_`` (GH-28903) (GH-28933)Miss Islington (bot)2021-10-131-4/+16
| | | | | | | | | | | | | | | | Also: * Expand the discussion into its own entry. (Even before this, text on ``_`` was longet than the text on ``_*``.) * Briefly note the other common convention for `_`: naming unused variables. Co-authored-by: Brandt Bucher <brandtbucher@gmail.com> Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit 3dee0cb6217db326e844955a7f8b424c67990557) Co-authored-by: Petr Viktorin <encukou@gmail.com>
generated by cgit v0.12 at 2025-01-30 09:35:16 (GMT)