summaryrefslogtreecommitdiffstats
path: root/Doc/tutorial
Commit message (Collapse)AuthorAgeFilesLines
* gh-102703: Fix typo in modules tutorial documentation (GH-102707)Miss Islington (bot)2023-03-151-1/+1
| | | | | | | | | **Before** This prevents directories with a common name, such as ``string``, unintentionally hiding ... **After** This prevents directories with a common name, such as ``string``, from unintentionally hiding ... (cherry picked from commit 0a539b5db312d126ff45dd4aa6a53d40a292c512) Co-authored-by: Robert Prater (B. Eng) <robcprater@gmail.com>
* [3.10] gh-102354: change python3 to python in docs examples (GH-102696) ↵Miss Islington (bot)2023-03-141-1/+1
| | | | | | | | (#102698) gh-102354: change python3 to python in docs examples (GH-102696) (cherry picked from commit 80abd62647b2a36947a11a6a8e395061be6f0c61) Co-authored-by: Paul Watson <paul.hermeneutic@gmail.com>
* docs: replace PyPI description with link (GH-101506)Miss Islington (bot)2023-02-031-2/+2
| | | | | (cherry picked from commit 45d014e03ba7ba4c9c912120ec36b2aca02061f4) Co-authored-by: François Magimel <magimel.francois@gmail.com>
* gh-100633 Tutorial: Fix dataclasses import (GH-100638)Miss Islington (bot)2022-12-311-1/+1
| | | | | | import dataclass not dataclasses from dataclasses (cherry picked from commit 98308dbeb110198ebe28bdb7720d3671b3e7f57b) Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
* gh-55688: Add note about ending backslashes for raw strings (GH-94768)Miss Islington (bot)2022-12-281-0/+5
| | | | | | (cherry picked from commit b95b1b3b25b0a93a22c7d58ac5bd5870e62070a8) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: hauntsaninja <hauntsaninja@gmail.com>
* gh-99908: Tutorial: Modernize the 'data-record class' example (GH-100499)Miss Islington (bot)2022-12-241-9/+15
| | | | | | (cherry picked from commit 00afa5066bd45348ed82a38d3442763b2ed1a068) Co-authored-by: JosephSBoyle <48555120+JosephSBoyle@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* gh-70393: Clarify mention of "middle" scope (GH-98839)Miss Islington (bot)2022-12-121-2/+2
| | | | | (cherry picked from commit 70be5e42f6e288de32e0df3c77ac22a9ddf1a74b) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* Doc: use "unnumbered" footnotes (GH-98954)Miss Islington (bot)2022-11-011-2/+2
| | | | | | | | Use unnumbered footnote in this file to avoid reseting the footnotes numbering. Example: when building the tutorial into a PDF and using `latex_show_urls = "footnotes"`; this footnote become the number 8. However, without this change, the footnote shows the number 1. (cherry picked from commit f042646595d1cdd2ecdc15222b1766f746d010f0) Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
* tutorial: remove "with single quotes" (GH-98204)Miss Islington (bot)2022-10-121-1/+1
| | | | | | | | | Closes GH-91856. On Windows double quotes are sometimes better, on Unix usually single quotes. It's not our place to explain that, so just don't. (cherry picked from commit 5f8ca1b7969f34ee09adb7b28337ebd920e6215a) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* doc: remove a misleading statement. (GH-98093)Miss Islington (bot)2022-10-101-2/+2
| | | | | (cherry picked from commit 571e23d99157ed7ad67ca2334a396fc9ddbe07ec) Co-authored-by: Julien Palard <julien@palard.fr>
* [3.10] gh-97654: Add auto exception chaining example to tutorial (GH-97703) ↵Miss Islington (bot)2022-10-051-5/+23
| | | | | | | | (#97884) Add auto exception chaining example to tutorial (cherry picked from commit 395b66a0ae5237eec195ca97daaaf8563706ed34) Co-authored-by: Shahriar Heidrich <smheidrich@weltenfunktion.de>
* [3.10] Use SyntaxError invalid range in tutorial introduction example ↵Miss Islington (bot)2022-09-301-2/+2
| | | | | | | | | | (GH-93031) (GH-97667) Use SyntaxError invalid range in tutorial introduction example (GH-93031) Use output from a 3.10+ REPL, showing invalid range, for the SyntaxError examples in the tutorial introduction page. Co-authored-by: Eddie Hebert <eddie@eddiehebert.com>
* gh-96959: Update HTTP links which are redirected to HTTPS (GH-96961)Miss Islington (bot)2022-09-251-1/+1
| | | | | (cherry picked from commit db39050396a104c73d0da473a2f00a62f9dfdfaa) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* gh-81039: Add small example of f-string's "=}" to tutorial (gh-92291) (gh-96990)Miss Islington (bot)2022-09-211-1/+11
| | | | | | | (cherry picked from commit 4b81139aac3fa11779f6eedb6e621bde29e64b30) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* Doc: Add omitted secondary prompt in inputoutput tutorial (GH-30317) (#95159)Miss Islington (bot)2022-07-231-1/+1
| | | | | | | | For the continuation lines, "..." should present as secondary prompt (cherry picked from commit de28ee8f755760fda13b481a34b1f326984d293a) Co-authored-by: Chenwei Xiao <chanvinxiao@163.com> Co-authored-by: Chenwei Xiao <chanvinxiao@163.com>
* Fix copy-friendliness of tutorial example (GH-93424)Miss Islington (bot)2022-07-221-0/+1
| | | | | (cherry picked from commit 34d11f1b0c0e1936a37581e0fb0daec637afca47) Co-authored-by: Chenwei Xiao <chanvinxiao@163.com>
* [3.10] Docs: remove redundant "adverb-adjective" hyphens from compound ↵Łukasz Langa2022-07-052-2/+2
| | | | | | | | 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>
* Docs: Update SyntaxError message in REPL example for list comprehension ↵Miss Islington (bot)2022-06-291-3/+3
| | | | | | | (GH-93901) (GH-94426) (cherry picked from commit 22b783aba05bcc3a21af9e5ae308ffbb98ff6a12) Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
* gh-61585: Clarify import scope in modules tutorial (GH-93455) (GH-94374)Miss Islington (bot)2022-06-281-10/+11
| | | | | | | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> (cherry picked from commit 4b854b746650214eddadb2440efd9e1544d08ccb)
* Closes gh-94152: Update pyvideo.org URL (GH-94075)Miss Islington (bot)2022-06-231-1/+1
| | | | | | The URL is now https://pyvideo.org, which uses HTTPS and avoids a redirect. (cherry picked from commit 7c439dca13435085efb2fddf9ac75e5305db7ada) Co-authored-by: partev <petrosyan@gmail.com>
* gh-94114: Remove obsolete reference to python.org mirrors (GH-94115)Miss Islington (bot)2022-06-221-4/+1
| | | | | | * gh-94114 (cherry picked from commit 8661c5053fbe3e246289d77e49a813470b3a16f7) Co-authored-by: partev <petrosyan@gmail.com>
* Tutorial: specify match cases don't fall through (GH-93615) (GH-94084)Miss Islington (bot)2022-06-211-2/+4
| | | | | (cherry picked from commit dd5cf84f245abf84405833320b8f25dbc43b24d2) Co-authored-by: max <36980911+pr2502@users.noreply.github.com>
* gh-93240: clarify wording in IO tutorial (GH-93276) (GH-94081)Miss Islington (bot)2022-06-211-1/+1
| | | | | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> (cherry picked from commit 51d673176ac90f2144e3e7a492e5b3ea53bdba2e) Co-authored-by: paulreece <96156234+paulreece@users.noreply.github.com>
* gh-89158: Add some REPL secondary prompt markers (GH-93073)Miss Islington (bot)2022-05-231-3/+3
| | | | | | | This fixes an issue on tutorial/classes.rst section 9.4 where the example "class Warehouse" was truncated when pressing the >>> button to hide the prompts and output. (cherry picked from commit 88f0d0c1e8fdda036f3f64b0048911ba28ce7f06) Co-authored-by: Nicolas Haller <nicolas@haller.im>
* gh-77521: Add link to builtin module names in modules tutorial (GH-92438)Miss Islington (bot)2022-05-081-1/+2
| | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 859250cc55711f4d62b65922d3f7537826c3801e) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* gh-92368: Fix missing possessive apostrophe (GH-92397)Miss Islington (bot)2022-05-061-1/+1
| | | | | | * Fix missing possessive apostrophe (cherry picked from commit a79001ee16b3ea8b5d0fad595c969d9e1b7627f3) Co-authored-by: gophra <105054704+gophra@users.noreply.github.com>
* gh-85679: Recommend `encoding="utf-8"` in tutorial (GH-91778)Miss Islington (bot)2022-05-021-10/+18
| | | | | (cherry picked from commit 614420df9796c8a4f01e24052fc0128b4c20c5bf) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* gh-91541: Fix error in example in modules tutorial (GH-91634)Miss Islington (bot)2022-04-171-1/+1
| | | | | (cherry picked from commit efbc668183400597070356a2df2fbab114a53cb3) Co-authored-by: 180909 <734461790@qq.com>
* Follow PEP-8 guidelines in tutorial for standard library (GH-26127)Miss Islington (bot)2022-04-031-2/+3
| | | | | (cherry picked from commit 6db2db91b96aaa1270c200ec931a2250fe2799c7) Co-authored-by: Bob Kline <bkline@users.noreply.github.com>
* [3.10] docs: Don't use code formatting for emphasis (GH-30519) (GH-31764)Jelle Zijlstra2022-03-081-1/+1
| | | | | (cherry picked from commit badb637c8ce91625122d5f4d71276bfe1a8ed5e9) Co-authored-by: William Andrea <william.j.andrea@gmail.com>
* docs: Link `match` statement in tutorial (GH-31396)Miss Islington (bot)2022-02-181-1/+1
| | | | | | | | | Add a link to the `match` statement from its section in the tutorial. Automerge-Triggered-By: GH:Mariatta (cherry picked from commit 35f55cc5c690a97853f1b544aac53574ab755b54) Co-authored-by: William Andrea <william.j.andrea@gmail.com>
* bpo-46270: Describe the `in` and `not in` operators as membership tests. ↵Miss Islington (bot)2022-01-101-4/+6
| | | | (GH-30504) (GH-30509)
* bpo-34538: Remove Exception subclassing from tutorial (GH-30361)Miss Islington (bot)2022-01-031-35/+1
| | | | | | | | | | Remove the bit about subclassing exceptions. Documentation PR can skip the NEWS label. Automerge-Triggered-By: GH:iritkatriel (cherry picked from commit 2db56130631255ca2eb504519430fb2f1fe789e9) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* bpo-46079: Replace external link that is down for maintenance. (GH-30315) ↵Miss Islington (bot)2022-01-011-6/+6
| | | | (GH-30328)
* Fix the output of built-in iter() function example in Iterators (Section ↵Miss Islington (bot)2021-12-161-1/+1
| | | | | | | | 9.8) of The Python Tutorial (GH-30110) Updated the output for it=iter(s) from <iterator object at 0x00A1DB50> to <str_iterator object at 0x10c90e650> (cherry picked from commit c5d18a5014f649368b5a4bca94e9ec7d2908b481) Co-authored-by: Vivek Vashist <vivekvashist@gmail.com>
* bpo-46059: Clarify pattern-matching example in "control flow" docs (GH-30079)Miss Islington (bot)2021-12-141-3/+5
| | | | | | | | The "Color" example in the pattern-matching section of the "control flow" documentation is not immediately runnable, leading to confusion. Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com> (cherry picked from commit 1cbb88736c32ac30fd530371adf53fe7554be0a5) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* bpo-45916: Use HTTPS link for The Perils of Floating Point (GH-29896)Miss Islington (bot)2021-12-021-1/+1
| | | | | (cherry picked from commit 9f2f7e42269db74a89fc8cd74d82a875787f01d7) Co-authored-by: Zachary Ware <zach@python.org>
* Closes bpo-45712: Add missing word in control flow tutorial (GH-29460)Miss Islington (bot)2021-11-081-1/+1
| | | | | (cherry picked from commit 7484a5c82a2dfc106bb1e4b060cad2df00521bfd) Co-authored-by: 180909 <734461790@qq.com>
* bpo-34451: Document prompt and output toggle feature in html tutorial ↵Miss Islington (bot)2021-10-211-0/+7
| | | | | | | (GH-27105) (GH-29119) (cherry picked from commit 5a14f71fe869d4a62dcdeb9a8fbbb5884c75060c) Co-authored-by: Thomas <thmsdnnr@gmail.com>
* bpo-38623: Add note about site module (site-packages) (GH-16974) (GH-28536)Miss Islington (bot)2021-09-231-1/+2
| | | | | (cherry picked from commit 55b45bf707c6c8084db259fe2f8aa08e84ea0d99) Co-authored-by: Peter Bittner <django@bittner.it>
* bpo-41203: Replace Mac OS X and OS X with macOS (GH-28515) (GH-28523)Miss Islington (bot)2021-09-231-1/+1
| | | | | | | | | | Replace old names when they refer to actual versions of macOS. Keep historical names in references to older versions. Co-authored-by: Patrick Reader <_@pxeger.com> (cherry picked from commit 36122e18148c5b6c78ebce1d36d514fd7cf250f5) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* bpo-39452: Rewrite and expand __main__.rst (GH-26883)Miss Islington (bot)2021-08-241-0/+2
| | | | | | | | | | Broadened scope of the document to explicitly discuss and differentiate between ``__main__.py`` in packages versus the ``__name__ == '__main__'`` expression (and the idioms that surround it), as well as ``import __main__``. Co-authored-by: Géry Ogam <gery.ogam@gmail.com> Co-authored-by: Éric Araujo <merwok@netwok.org> Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit 7cba23164cf82f6619db002cd30021b5dfb1f809) Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>
* bpo-44966: Fix out-of-date traceback message (GH-27867)Miss Islington (bot)2021-08-221-1/+1
| | | | | (cherry picked from commit 15a64d89a31b7e91f0361c305b7b27d8761db93d) Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
* introduce omitted index default before using it (GH-27775) (GH-27802)Miss Islington (bot)2021-08-171-8/+8
| | | | | (cherry picked from commit 599f5c8481ca258ca3a5d13eaee7d07a9103b5f2) Co-authored-by: Jefferson Oliveira <jefferson.dev.insights@gmail.com>
* bpo-44907: Update error messages in tutorial examples (GH-27755)Miss Islington (bot)2021-08-141-3/+3
| | | | | | (cherry picked from commit ed524b4569b1e4a166886c880018418d46284378) Co-authored-by: meowmeowmeowcat <meowmeowcat1211@gmail.com>
* bpo-41576: document BaseException in favor of bare except (GH-21917)Miss Islington (bot)2021-08-061-8/+9
| | | | | (cherry picked from commit e9a6f1b78bf57d9f3f99547bd007d7cfc9724cfb) Co-authored-by: Thomas Grainger <tagrain@gmail.com>
* bpo-44740: Lowercase "internet" and "web" where appropriate. (GH-27378) ↵Miss Islington (bot)2021-07-263-4/+4
| | | | | | | | (GH-27380) Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit 11749e2dc20ad6a76e9a39e948853e89b2b4bbed) Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
* bpo-40620: Clarify tutorial controlflow.rst ``range`` examples (GH-26919) ↵Miss Islington (bot)2021-06-271-14/+8
| | | | | | | | (GH-26927) (cherry picked from commit 2f49c9debc2efe010c757be3bdbd6493f1ebc5f6) Co-authored-by: jdevries3133 <58614260+jdevries3133@users.noreply.github.com>
* bpo-43927: Change 'IOError' to 'OSError' (GH-26289)Miss Islington (bot)2021-05-211-1/+1
| | | | | | This is the last remaining instance, at least for this chapter, in 3.10 & 3.11. (cherry picked from commit 2f47d8dcc735234bf9c7f92fbdacd8c5a6ee7761) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* bpo-35765: Clarify references to "object x" in the JSON tutorial (GH-22411) ↵Miss Islington (bot)2021-05-191-1/+2
| | | | | | | | (GH-26218) (cherry picked from commit 4fdcc39f711e1b586a94e2c5088fdd7e78fd9f58) Co-authored-by: Zackery Spytz <zspytz@gmail.com>