summaryrefslogtreecommitdiffstats
path: root/Doc/tutorial
Commit message (Collapse)AuthorAgeFilesLines
* Improve IO tutorial's "Old string formatting" section (GH-16251)Miss Islington (bot)2020-05-281-5/+5
| | | | | | | | * Use a more universal explanation of string interpolation rather than specifically referencing sprintf(), which depends on the reader having a C background. Co-authored-by: Kyle Stanley <aeros167@gmail.com> (cherry picked from commit eaca2aa117d663acf8160a0b4543ee2c7006fcc7) Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
* bpo-39869: Fix typo in 'Instance objects' section. (GH-18889)Miss Islington (bot)2020-03-101-1/+1
| | | | | (cherry picked from commit e5e56328afac50aad6d8893185d8e7ba8928afe2) Co-authored-by: Antoine <43954001+awecx@users.noreply.github.com>
* bpo-39534: Doc: Clarify return in finally (GH-18324)Miss Islington (bot)2020-02-061-9/+27
| | | | | (cherry picked from commit 446463f8dbce0556be8020914f37089b63bb8ab6) Co-authored-by: Julien Palard <julien@palard.fr>
* bpo-39431: Also mention nonlocal in assignment quirk (GH-17375)Miss Islington (bot)2020-01-231-4/+4
| | | | | (cherry picked from commit 7142df5ea23b4ce0efb72746b4b3b65414e8dcb1) Co-authored-by: Shanavas M <shanavas.m2@gmail.com>
* bpo-38678: Improve argparse example in tutorial (GH-17207) (GH-17213)Miss Islington (bot)2019-11-181-15/+17
| | | | | (cherry picked from commit 04c79d6088a22d467f04dbe438050c26de22fa85) Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
* [3.7] [3.8] Update interpreter.rst (GH-17059) (GH-17060) (GH-17061)Jules Lasne (jlasne)2019-11-051-1/+1
| | | | | | | | | | Fixed what seemed to be a weird phrasing. (cherry picked from commit 5e01a6542a1beb552a17e16b71dc0ba9fc6adcfb) Co-authored-by: Jules Lasne (jlasne) <jules.lasne@gmail.com>. (cherry picked from commit 1eac437e8da106a626efffe9fce1cb47dbf5be35) Co-authored-by: Jules Lasne (jlasne) <jules.lasne@gmail.com>
* bpo-38130: Fix error in explaining when an exception is re-raised (GH-16016) ↵Miss Islington (bot)2019-09-261-1/+1
| | | | | | | | (GH-16416) Co-Authored-By: Ashwin Ramaswami <aramaswamis@gmail.com> (cherry picked from commit 1ad7be2f16cc9955f271f57a5089602bb41eee85) Co-authored-by: Mohammad Dehghan <md.unicorn@gmail.com>
* [3.7] bpo-38218: Doc: Corrected syntax for return annotation (GH-16265) ↵Miss Islington (bot)2019-09-191-1/+1
| | | | | | | | (GH-16275) Signed-off-by: Jason Plurad <pluradj@us.ibm.com> (cherry picked from commit 9ab6038fe843e1193d795eb58fd5931b44be5a96) Co-authored-by: Jason Plurad <pluradj@us.ibm.com>
* bpo-37904: Edition on python tutorial - section 4 (GH-16169) (GH-16235)Miss Islington (bot)2019-09-181-2/+2
| | | | | | | | | | A little change on first paragraph of python tutorial to be more clearly https://bugs.python.org/issue37904 Automerge-Triggered-By: @ericvsmith (cherry picked from commit b57481318e3e3cbacd398b898f9849ec8f2d7eec) Co-authored-by: Diego Alberto Barriga Martínez <diegobarriga@protonmail.com>
* Doc: Add link of GNU Readline library to interpreter tutorial (GH-16152) ↵Miss Islington (bot)2019-09-161-7/+8
| | | | | | | (GH-16188) (cherry picked from commit f18242be16714da2cfe013dbadfaf2e31d971562) Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
* bpo-37635: Update arg name for seek() in IO tutorial (GH-16147)Miss Islington (bot)2019-09-141-3/+3
| | | | | | | | | | | | | | | | | | | | | Typically, the second positional argument for ``seek()`` is *whence*. That is the POSIX standard name (http://man7.org/linux/man-pages/man3/lseek.3p.html) and the name listed in the documentation for ``io`` module (https://docs.python.org/3/library/io.htmlGH-io.IOBase.seek). The tutorial for IO is the only location where the second positional argument for ``seek()`` is referred to as *from_what*. I suspect this was created at an early point in Python's history, and was never updated (as this section predates the GitHub repository): ``` $ git grep "from_what" Doc/tutorial/inputoutput.rst:To change the file object's position, use ``f.seek(offset, from_what)``. The position is computed Doc/tutorial/inputoutput.rst:the *from_what* argument. A *from_what* value of 0 measures from the beginning Doc/tutorial/inputoutput.rst:the reference point. *from_what* can be omitted and defaults to 0, using the ``` For consistency, I am suggesting that the tutorial be updated to use the same argument name as the IO documentation and POSIX standard for ``seek()``, particularly since this is the only location where *from_what* is being used. Note: In the POSIX standard, *whence* is technically the third positional argument, but the first argument *fildes* (file descriptor) is implicit in Python. https://bugs.python.org/issue37635 (cherry picked from commit ff603f6c3d3dc0e9ea8c1c51ce907c4821f42c54) Co-authored-by: Kyle Stanley <aeros167@gmail.com>
* Improve clarity of try-return-finally-return (GH-15677) (GH-15982)Miss Islington (bot)2019-09-111-9/+22
| | | | | | Clarify execution in try-return-finally-return case. (cherry picked from commit 0cc27417f2cd399c432d7dda9aeca1d81af76936) Co-authored-by: toonarmycaptain <toonarmycaptain@hotmail.com>
* Correct info about "f.read(size)". (GH13852)Miss Islington (bot)2019-09-101-2/+2
| | | | | | In text mode, the "size" parameter indicates the number of characters, not bytes. (cherry picked from commit faff81c05f838b0b7a64bbc8c53c02a9b04bb79d) Co-authored-by: William Andrea <william.j.andrea@gmail.com>
* bpo-37726: Prefer argparse over getopt in stdlib tutorial (GH-15052) (#15069)Miss Islington (bot)2019-08-011-4/+15
| | | | | (cherry picked from commit 2491134029b195d3159a489e1803ee22a7839b41) Co-authored-by: mental <m3nta1@yahoo.com>
* Doc: Fix: Proper UpperCamelCase and lowercase. (GH-14644)Miss Islington (bot)2019-07-081-1/+1
| | | | | | Initial report by Michael Blankenship on docs@ (cherry picked from commit 2da622ff77a763327895656779370b80a833d95c) Co-authored-by: Julien Palard <julien@palard.fr>
* Improve Windows commands in tutorial (GH-14401)Steve Dower2019-06-261-6/+4
|
* bpo-36739: Update controlflow.rst (GH-12983)Miss Islington (bot)2019-05-291-3/+5
| | | | | | | in addition to global-statement also mention nonlocal-statement (in the paragraph describing access to variables which are non local to a function (cherry picked from commit e1f95e77e0647aff602e0660ba3c282b71045875) Co-authored-by: pbhd <p-bauer-schriesheim@t-online.de>
* Doc: Add missing forward reference in the tutorial. (GH-13499)Miss Islington (bot)2019-05-281-3/+3
| | | | | (cherry picked from commit 51ddab8dae056867f3595ab3400bffc93f67c8d4) Co-authored-by: Julien Palard <julien@palard.fr>
* Add a footnote about Cheese Shop in Doc/tutorial (GH-13103) (GH-13174)Miss Islington (bot)2019-05-071-1/+7
| | | | | (cherry picked from commit e19a91e45fd54a56e39c2d12e6aaf4757030507f) Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
* bpo-36189: Fixing typo in tutorial introduction (GH-13093)Miss Islington (bot)2019-05-051-1/+1
| | | | | (cherry picked from commit 98a1e06c47f655c7601b130cf8d549de9f08369e) Co-authored-by: Jonatan <jonyucra@gmail.com>
* closes bpo-35329: Change 'Package' to 'package' in accordance with PEP8. ↵Miss Islington (bot)2019-04-301-1/+1
| | | | | | | (GH-13008) (cherry picked from commit ee0309f3d83ab9ffa02542bcf45ece84f4fb265e) Co-authored-by: Utkarsh Gupta <guptautkarsh2102@gmail.com>
* better __init__.py explanation in tutorial (GH-12763)Miss Islington (bot)2019-04-111-3/+3
| | | | | | | | | | * better __init__.py explanation in tutorial * Update Doc/tutorial/modules.rst Co-Authored-By: methane <songofacandy@gmail.com> (cherry picked from commit 5410d3d283b11e2375f0c1f79728a230edd12bd0) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* Minor doc improvement (GH-10341)Miss Islington (bot)2019-03-271-2/+2
| | | | | | Change "star-operator" to "* operator". (cherry picked from commit dfd775a0b1aee51d842b20cdebd97cc52c0b32e7) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* [3.7] Replace "DOS box" with link to Windows FAQ. (GH-12390) (GH-12525)Miss Islington (bot)2019-03-241-1/+1
| | | | | | (cherry picked from commit 6661c1720ebd322e2cb6995a243e8dc6e588d931) Co-authored-by: Ned Deily <nad@python.org>
* bpo-35566: Add links to annotation glossary term (GH-11291) (GH-11302)Miss Islington (bot)2018-12-241-4/+4
|
* [3.7] bpo-35506: Remove redundant and incorrect links from keywords. ↵Serhiy Storchaka2018-12-196-36/+36
| | | | | | (GH-11174). (GH-11232) (cherry picked from commit 2b57c43f21f891df4c6f2294a3b9e1b9029a16b6)
* Add a reference to the name mangling description in the tutorial to the ↵Miss Islington (bot)2018-11-071-0/+3
| | | | | | | index. (GH-10138) (cherry picked from commit c5eec4426d9144b2255500217d0e3ff9463d2770) Co-authored-by: Andrés Delfino <adelfino@gmail.com>
* Fix a typo about a comma. (GH-10306)Miss Islington (bot)2018-11-031-1/+1
| | | | | (cherry picked from commit fe62d877e300e1ee4145fff8f2bdba498b685f91) Co-authored-by: İsmail Arılık <arilik.ismail@gmail.com>
* [3.7] bpo-35110: Fix unintentional spaces around hyphens and dashes. ↵Serhiy Storchaka2018-10-311-2/+2
| | | | | | (GH-10231). (GH-10253) (cherry picked from commit 3f819ca138db6945ee4271bf13e42db9f9b3b1e4)
* bpo-35054: Add yet more index entries for symbols. (GH-10121) (GH-10171)Miss Islington (bot)2018-10-282-3/+3
| | | | | (cherry picked from commit 913876d824d969f8c7431e8a9d4610a9a11a786e) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037)Miss Islington (bot)2018-10-261-1/+1
| | | | | (cherry picked from commit e483f02423917dc4dfd25f46e5b9e6fce304777d) Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
* [3.7] bpo-35054: Add more index entries for symbols. (GH-10064). (GH-10120)Serhiy Storchaka2018-10-262-3/+6
| | | | | (cherry picked from commit ddb961d2abe5d5fde76d85b21a77e4e91e0043ad) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* bpo-21196: Clarify name mangling rules in tutorial (GH-5667)Miss Islington (bot)2018-10-201-0/+5
| | | | | | Initial patch by Chandan Kumar. (cherry picked from commit 13ae4d44381a647aadd09b70b24833052659be41) Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
* [3.7]Documentation minor update related to 3.6 - 3.7 migration (GH-9501)Christophe Nanteuil2018-09-241-2/+2
| | | | | Change version from 3.6 to 3.7 in the documentation when it addresses newcomers. original request from python/python-docs-fr#273
* bpo-34712: Fix style in examples in "Input and Output" (GH-9361)Miss Islington (bot)2018-09-191-4/+7
| | | | | | | | | | | | A couple of fixes here to make this more PEP-8: * Avoid multiple statements on one line with `;` statement separator -- this is very rare in Python and is "generally discouraged" in PEP 8 (and if used, per PEP 8 there shouldn't be a space before the `;`) * Add output for the first "Formatted String Literals" example. (Side note: are the doctests for this being run? If so, why didn't it fail?) * Avoid space before `!r`. I have generally not seen spaces before the `!`, and this also matches the style used in the docs here: https://docs.python.org/3/library/string.htmlGH-format-string-syntax https://bugs.python.org/issue34712 (cherry picked from commit 3705b9862025705ea60041a9e310f99a164db722) Co-authored-by: Ben Hoyt <benhoyt@gmail.com>
* bpo-33460: remove ellipsis that look like continuation prompts (GH-7851)Miss Islington (bot)2018-09-111-4/+10
| | | | | | | Remove ellipsis that look like continuation prompts, has a side benefit of putting rest of error message in proper text color. (cherry picked from commit f019579828ed62653e2d41c95278308fa076ccaf) Co-authored-by: Lew Kurtz <37632626+lew18@users.noreply.github.com>
* Doc: Missing 'f' in an f-string. (GH-9074) (GH-9095)Miss Islington (bot)2018-09-071-1/+1
| | | | | (cherry picked from commit 25fa141487e61b94f15289619cb3af764cf65e58) Co-authored-by: Julien Palard <julien@palard.fr>
* Update list.remove(x) documentation (GH-8636)Miss Islington (bot)2018-08-031-2/+2
| | | | | | Rephrase it to "It raises a `ValueError`" (cherry picked from commit bcd1d971b66f529cbd450aca438275b868031605) Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
* bpo-28677: Improve phrasing of when instance attribute is referenced (GH-6208)Miss Islington (bot)2018-07-251-2/+2
| | | | | (cherry picked from commit c0f0a7669c73c0d444851dd4c5299de2479214cc) Co-authored-by: Aaron Ang <aaronang@users.noreply.github.com>
* bpo-34161: Remove extra parentheses in output formatting tutorial (GH-8350)Miss Islington (bot)2018-07-201-2/+2
| | | | | | The parentheses were incorrect. (cherry picked from commit cb5f3fdb9d353a572dd22fb50a110e52d5bb81b1) Co-authored-by: Aaqa Ishtyaq <aaqaishtyaq@gmail.com>
* Fix documentation for input and output tutorial (GH-8231)Miss Islington (bot)2018-07-111-1/+1
| | | | | | The ValueError message ends with a period. (cherry picked from commit 9cffdbffc3b2dec18def1c3e8cfa166d01d609df) Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
* bpo-28626: rearrange discussion of output formatting to encourage f-strings ↵Miss Islington (bot)2018-07-091-89/+138
| | | | | | | | | | (GH-6036) The 'output formatting' section of the tutorial talks a lot about manual formatting with things like .rjust() and .zfill(), with only a passing reference to 3.6's new f-strings. This doesn't drop all of the old material, but it does rearrange the topics into a more modern order: f-strings first, discussing formatting specifiers a bit; then calling .format(); finally manual formatting with .ljust(). (cherry picked from commit ced350b1952857a9b9c68ec7e2786358bcb61050) Co-authored-by: Andrew Kuchling <amk@amk.ca>
* use rich markup for PEP reference (GH-7939)Miss Islington (bot)2018-06-271-1/+1
| | | | | | it's better to refer to PEP with `pep` role in reStructuredText. It also links to the PEP page. (cherry picked from commit df748c20dabcec5a6e89e0dd74fff21110f8755a) Co-authored-by: Behzad B. Mokhtari <35877268+perplexionist@users.noreply.github.com>
* bpo-33892: Doc: Use gender neutral words (GH-7770)Miss Islington (bot)2018-06-181-10/+10
| | | | | (cherry picked from commit 5092439c2cb32112a5869b138011d38491db90a9) Co-authored-by: Andrés Delfino <adelfino@gmail.com>
* bpo-33641: Convert RFC references into links. (GH-7103)Miss Islington (bot)2018-05-311-1/+1
| | | | | | 85% of them are already links. (cherry picked from commit 0a36ac1a09587735237c5978ebd046313922869c) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* bpo-33503: Fix the broken pypi link in the source and the documentation ↵Miss Islington (bot)2018-05-162-2/+2
| | | | | | | (GH-6814) (GH-6872) (cherry picked from commit 19177fbd5d6d9b29ccc302d65f9d9417ece082ce) Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
* bpo-13525: Fix incorrect encoding name in the tutorial example. (GH-6738)Miss Islington (bot)2018-05-091-2/+2
| | | | | (cherry picked from commit ddb6215a55b0218b621d5cb755e9dfac8dab231a) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* Mention both relevant PEPs in function annotations tutorial (GH-6304)Miss Islington (bot)2018-04-251-2/+2
| | | | | | Patch by Neeraj Badlani. (cherry picked from commit 643ff711faf417fc3428897dc7d36250ad2cb0e5) Co-authored-by: Neeraj Badlani <neerajbadlani@gmail.com>
* bpo-33297: Mention Pillow to work with more image formats. (GH-6505)Miss Islington (bot)2018-04-211-1/+1
| | | | | | Also update PIL doc references to Pillow. (cherry picked from commit b81ca28b378c8b29204a37f8bd433a3379f53f7d) Co-authored-by: Andrés Delfino <34587441+andresdelfino@users.noreply.github.com>
* Improve highlighting of some code blocks. (GH-6401)Miss Islington (bot)2018-04-091-1/+1
| | | | | (cherry picked from commit 46936d5a71d1683dbd8ddb6d7f39aab50ecfec50) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
generated by cgit v0.12 at 2025-12-30 23:02:19 (GMT)