summaryrefslogtreecommitdiffstats
path: root/Doc/tutorial
Commit message (Collapse)AuthorAgeFilesLines
* bpo-42179: Doc/tutorial: Remove mention of __cause__ (GH-23162)Miss Islington (bot)2020-11-061-9/+10
| | | | | (cherry picked from commit bde33e428d5b5f88ec7667598fd27d1091840537) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* bpo-41776: Revise example of "continue" in the tutorial documentation ↵Miss Islington (bot)2020-09-151-5/+5
| | | | | | | | | | (GH-22234) (GH-22255) Revise example of "continue" in the tutorial documentation (cherry picked from commit 7bcc6456ad4704da9b287c8045768fa53961adc5) Co-authored-by: Neeraj Samtani <neerajjsamtani@gmail.com> Co-authored-by: Neeraj Samtani <neerajjsamtani@gmail.com>
* Fix grammar in Doc/tutorial/controlflow.rst (GH-21885) (#21922)Miss Islington (bot)2020-08-221-1/+1
| | | | | | | Automerge-Triggered-By: @csabella (cherry picked from commit 0be7c216e16f0d459f1c8f6209734c9b2b82fbd4) Co-authored-by: Denis Ovsienko <denis@ovsienko.info>
* [3.9] bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) (GH-21901)Victor Stinner2020-08-191-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) Enable Sphinx 3.2 "c_allow_pre_v3" option and disable the c_warn_on_allowed_pre_v3 option to make the documentation compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 423e77d6de497931585d1883805a9e3fa4096b0b) * bpo-40204: Fix Sphinx sytanx in howto/instrumentation.rst (GH-21858) Use generic '.. object::' to declare markers, rather than abusing '.. c:function::' which fails on Sphinx 3. (cherry picked from commit 43577c01a2ab49122db696e9eaec6cb31d11cc81) * bpo-40204: Fix duplicates in the documentation (GH-21857) Fix two Sphinx 3 issues: Doc/c-api/buffer.rst:304: WARNING: Duplicate C declaration, also defined in 'c-api/buffer'. Declaration is 'PyBUF_ND'. Doc/c-api/unicode.rst:1603: WARNING: Duplicate C declaration, also defined in 'c-api/unicode'. Declaration is 'PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, const char *errors)'. (cherry picked from commit 46d10b1237c67ff8347f533eda6a5468d098f7eb) * bpo-40204: Add :noindex: in the documentation (GH-21859) Add :noindex: to duplicated documentation to fix "duplicate object description" errors. For example, fix this Sphinx 3 issue: Doc/library/configparser.rst:1146: WARNING: duplicate object description of configparser.ConfigParser.optionxform, other instance in library/configparser, use :noindex: for one of them (cherry picked from commit d3ded080482beae578faa704b13534a62d066f9f) * bpo-40204, doc: Fix syntax of C variables (GH-21846) For example, fix the following Sphinx 3 errors: Doc/c-api/buffer.rst:102: WARNING: Error in declarator or parameters Invalid C declaration: Expected identifier in nested name. [error at 5] void \*obj -----^ Doc/c-api/arg.rst:130: WARNING: Unparseable C cross-reference: 'PyObject*' Invalid C declaration: Expected end of definition. [error at 8] PyObject* --------^ The modified documentation is compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 474652fe9346382dbf793f20b671eb74668bebde) * bpo-40204: Fix reference to terms in the doc (GH-21865) Sphinx 3 requires to refer to terms with the exact case. For example, fix the Sphinx 3 warning: Doc/library/pkgutil.rst:71: WARNING: term Loader not found in case sensitive match.made a reference to loader instead. (cherry picked from commit bb0b08540cc93e56f3f1bde1b39ce086d9e35fe1) * bpo-40204: Fix duplicated productionlist names in the doc (GH-21900) Sphinx 3 disallows having more than one productionlist markup with the same name. Simply remove names in this case, since names are not shown anyway. For example, fix the Sphinx 3 warning: Doc/reference/introduction.rst:96: duplicate token description of *:name, other instance in reference/expressions (cherry picked from commit 1abeda80f760134b4233608e2c288790f955b95a)
* Fix repeated words in Classes tutorial (GH-21455)Miss Islington (bot)2020-07-141-2/+2
| | | | | | | | The phrase "At any time during execution," was repeated twice. Automerge-Triggered-By: @Mariatta (cherry picked from commit 4f28f75deefc6e8f65694f96f1a40b0a26fc385d) Co-authored-by: Paul McMillan <paul@mcmillan.ws>
* bpo-28681: Clarify multiple function names in the tutorial (GH-21340) (GH-21343)Miss Islington (bot)2020-07-061-5/+4
| | | | | | | | | | | | | | * improve control flow docs * Add also Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> (cherry picked from commit d12af71047f0eae86440654d3ea74c032c7c3558) Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com> Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
* bpo-26205: Specify the number of nested scopes (GH-21324) (GH-21341)Miss Islington (bot)2020-07-061-2/+2
| | | | | | | | | | | | | | * Clarify number of scopes * Indicate 3 or 4 Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> (cherry picked from commit 9ed3cd8ba052b395ab50692bb65988b065d68e27) Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com> Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
* 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-39705 : sorted() tutorial example under looping techniques improved ↵Rahul Kumaresan2020-05-181-0/+15
| | | | (GH-18999)
* Change 'exception happened' to 'exception occurred' in two places (#19767)Noah Doersing2020-05-011-1/+1
|
* bpo-39869: Fix typo in 'Instance objects' section. (GH-18889)Antoine2020-03-101-1/+1
|
* Grammar fix in tutorial (GH-18425)Don Kirkby2020-02-101-1/+1
|
* bpo-39534: Doc: Clarify return in finally (GH-18324)Julien Palard2020-02-061-9/+27
|
* bpo-38558: Link to further docs from walrus operator mention in tutorial ↵Adorilson Bezerra2020-02-031-3/+4
| | | | (GH-16973)
* bpo-39431: Also mention nonlocal in assignment quirk (GH-17375)Shanavas M2020-01-231-4/+4
|
* bpo-38678: Improve argparse example in tutorial (GH-17207)Raymond Hettinger2019-11-181-15/+17
|
* Update interpreter.rst (GH-17059)Jules Lasne (jlasne)2019-11-051-1/+1
| | | Fixed what seemed to be a weird phrasing.
* bpo-38558: Mention `:=` in conditions tutorial (GH-16919)Ammar Askar2019-10-251-4/+4
|
* bpo-38130: Fix error in explaining when an exception is re-raised (GH-16016)Mohammad Dehghan2019-09-261-1/+1
| | | | Co-Authored-By: Ashwin Ramaswami <aramaswamis@gmail.com>
* Doc: Corrected syntax for return annotation (GH-16265)Jason Plurad2019-09-191-1/+1
| | | Signed-off-by: Jason Plurad <pluradj@us.ibm.com>
* bpo-37904: Edition on python tutorial - section 4 (GH-16169)Diego Alberto Barriga Martínez2019-09-171-2/+2
| | | | | | | | | | | A little change on first paragraph of python tutorial to be more clearly https://bugs.python.org/issue37904 Automerge-Triggered-By: @ericvsmith
* Doc: Add link of GNU Readline library to interpreter tutorial (GH-16152)Adorilson Bezerra2019-09-161-7/+8
|
* Doc: remove duplicate word in controlflow tutorial (GH-16163)Adorilson Bezerra2019-09-161-1/+1
|
* 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.
generated by cgit v0.12 at 2025-09-13 23:14:15 (GMT)