summaryrefslogtreecommitdiffstats
path: root/Doc/tutorial
Commit message (Collapse)AuthorAgeFilesLines
* bpo-37635: Update arg name for seek() in IO tutorial (GH-16147)Kyle Stanley2019-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.html#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
* Improve clarity of try-return-finally-return (GH-15677)toonarmycaptain2019-09-111-9/+22
| | | Clarify execution in try-return-finally-return case.
* Correct info about "f.read(size)". (GH13852)William Andrea2019-09-101-2/+2
| | | In text mode, the "size" parameter indicates the number of characters, not bytes.
* bpo-14112: Allow beginners to explore shallowness in greater depth ;-) ↵Raymond Hettinger2019-08-241-1/+2
| | | | (GH-15465)
* bpo-30826: Improve control flow examples (GH-15407)Raymond Hettinger2019-08-231-14/+14
|
* bpo-12634: Clarify an awkward section of the tutorial (GH-15406)Raymond Hettinger2019-08-231-6/+14
|
* bpo-14050: Note that not all data can be sorted (GH-15381)Raymond Hettinger2019-08-221-0/+7
|
* bpo-37826: Document exception chaining in Python tutorial for errors. (GH-15243)Abhilash Raj2019-08-141-0/+47
| | | https://bugs.python.org/issue37826
* bpo-37726: Prefer argparse over getopt in stdlib tutorial (#15052)mental2019-08-011-4/+15
|
* Doc: Fix: Proper UpperCamelCase and lowercase. (GH-14644)Julien Palard2019-07-081-1/+1
| | | Initial report by Michael Blankenship on docs@
* bpo-37403: Touch up venv docs (GH-14458)Brett Cannon2019-06-281-0/+6
| | | Add a versionadded for PS Core and note that `.venv` is a common virtual environment name.
* Improve Windows commands in tutorial (GH-14379)Steve Dower2019-06-261-6/+4
|
* bpo-37392: Update the dir(sys) in module tutorial (GH-14365)Xtreak2019-06-251-16/+20
|
* Use `python -m pip install` in porting guide and venv docs (GH-13257)Brad2019-06-211-4/+4
| | | This is to help prevent people from accidentally installing into the wrong Python interpreter if they are not aware of which Python interpreter `pip` points to.
* Bump to 3.9.0a0Łukasz Langa2019-06-043-6/+6
|
* bpo-29414: Change 'the for statement is such an iterator' in Tutorial (GH-273)Marco Buttu2019-06-011-10/+16
|
* bpo-36739: Update controlflow.rst (GH-12983)pbhd2019-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
* bpo-36540: Documentation for PEP570 - Python positional only arguments (#13202)Pablo Galindo2019-05-281-0/+170
| | | | | | | | | | | | | | | | | | * bpo-36540: Documentation for PEP570 - Python positional only arguments * fixup! bpo-36540: Documentation for PEP570 - Python positional only arguments * Update reference for compound statements * Apply suggestions from Carol Co-Authored-By: Carol Willing <carolcode@willingconsulting.com> * Update Doc/tutorial/controlflow.rst Co-Authored-By: Carol Willing <carolcode@willingconsulting.com> * Add extra bullet point and minor edits
* Doc: Add missing forward reference in the tutorial. (GH-13499)Julien Palard2019-05-281-3/+3
|
* bpo-36008: Doc update for 3.8 migration (GH-12887)Utkarsh Gupta2019-05-131-2/+2
|
* Add a footnote about Cheese Shop in Doc/tutorial (GH-13103)Adorilson Bezerra2019-05-071-1/+7
|
* bpo-36189: Fixing typo in tutorial introduction (GH-13090)Jonatan2019-05-041-1/+1
|
* closes bpo-35329: Change 'Package' to 'package' in accordance with PEP8. ↵Utkarsh Gupta2019-04-301-1/+1
| | | | (GH-13008)
* Clarify file-closing example in tutorial (GH-11652)Colin Watson2019-04-171-0/+2
|
* better __init__.py explanation in tutorial (#12763)Inada Naoki2019-04-111-3/+3
| | | | | | | | * better __init__.py explanation in tutorial * Update Doc/tutorial/modules.rst Co-Authored-By: methane <songofacandy@gmail.com>
* bpo-36377: Specify that range() can not be compared (GH-12468)Emmanuel Arias2019-04-021-12/+11
|
* Revert "Minor doc improvement (GH-10341)" (GH-12597)Raymond Hettinger2019-03-281-2/+2
| | | This reverts commit dfd775a0b1aee51d842b20cdebd97cc52c0b32e7.
* Minor doc improvement (GH-10341)Andre Delfino2019-03-271-2/+2
| | | Change "star-operator" to "* operator".
* Replace "DOS box" with link to Windows FAQ. (GH-12390)Ned Deily2019-03-241-1/+1
|
* bpo-35566: Add links to annotation glossary term (GH-11291)Cheryl Sabella2018-12-241-4/+4
|
* bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174)Serhiy Storchaka2018-12-196-36/+36
|
* Add a reference to the name mangling description in the tutorial to the ↵Andrés Delfino2018-11-071-0/+3
| | | | index. (GH-10138)
* Fix a typo about a comma. (GH-10306)İsmail Arılık2018-11-031-1/+1
|
* bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231)Serhiy Storchaka2018-10-311-2/+2
|
* bpo-35054: Add yet more index entries for symbols. (GH-10121)Serhiy Storchaka2018-10-282-3/+3
|
* bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037)Stéphane Wirtel2018-10-261-1/+1
|
* bpo-35054: Add more index entries for symbols. (GH-10064)Serhiy Storchaka2018-10-262-3/+6
|
* bpo-21196: Clarify name mangling rules in tutorial (GH-5667)Berker Peksag2018-10-201-0/+5
| | | Initial patch by Chandan Kumar.
* bpo-34712: Fix style in examples in "Input and Output" (GH-9361)Ben Hoyt2018-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.html#format-string-syntax https://bugs.python.org/issue34712
* bpo-33460: remove ellipsis that look like continuation prompts (GH-7851)Lew Kurtz2018-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.
* Doc: Missing 'f' in an f-string. (GH-9074)Julien Palard2018-09-071-1/+1
|
* Update list.remove(x) documentation (GH-8636)Lysandros Nikolaou2018-08-031-2/+2
| | | Rephrase it to "It raises a `ValueError`"
* bpo-28677: Improve phrasing of when instance attribute is referenced (GH-6208)Aaron Ang2018-07-251-2/+2
|
* Remove extra parentheses in output formatting tutorial (GH-8350)Aaqa Ishtyaq2018-07-201-2/+2
| | | The parentheses were incorrect.
* Fix documentation for input and output tutorial (GH-8231)Lysandros Nikolaou2018-07-111-1/+1
| | | The ValueError message ends with a period.
* bpo-28626: rearrange discussion of output formatting to encourage f-strings ↵Andrew Kuchling2018-07-071-89/+138
| | | | | | | | (#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().
* use rich markup for PEP reference (GH-7939)Behzad B. Mokhtari2018-06-271-1/+1
| | | it's better to refer to PEP with `pep` role in reStructuredText. It also links to the PEP page.
* bpo-33892: Doc: Use gender neutral words (GH-7770)Andrés Delfino2018-06-181-10/+10
|
* bpo-33641: Convert RFC references into links. (GH-7103)Serhiy Storchaka2018-05-311-1/+1
| | | | 85% of them are already links.
* bpo-33503: Fix the broken pypi link in the source and the documentation ↵Stéphane Wirtel2018-05-152-2/+2
| | | | (GH-6814)
generated by cgit v0.12 at 2024-11-24 05:46:43 (GMT)