fde74be61b
gh-73196: Add namespace/scope clarification for inheritance section ( #92840 )
...
Add namespace/scope clarification for inheritance section
2022-10-07 12:04:14 -07:00
395b66a0ae
gh-97654: Add auto exception chaining example to tutorial ( #97703 )
...
Add auto exception chaining example to tutorial
2022-10-04 17:36:04 -07:00
86a3be207d
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.
Automerge-Triggered-By: GH:iritkatriel
2022-09-30 01:59:46 -07:00
db39050396
gh-96959: Update HTTP links which are redirected to HTTPS (GH-96961)
2022-09-24 14:38:53 +03:00
4b81139aac
gh-81039: Add small example of f-string's "=}" to tutorial (gh-92291)
2022-09-21 08:57:03 -04:00
b17aae8bbd
gh-95413: Remove references to deprecated CGI library ( #95414 )
2022-08-30 13:14:08 +02:00
d8c7a1174c
small grammatical change (GH-96138)
...
changed a to an under An example that uses most of the list methods
2022-08-21 09:56:52 -05:00
de28ee8f75
Doc: Add omitted secondary prompt in inputoutput tutorial (GH-30317)
...
For the continuation lines, "..." should present as secondary prompt
2022-07-23 17:25:42 +08:00
34d11f1b0c
Fix copy-friendliness of tutorial example (GH-93424)
2022-07-22 15:11:48 -05:00
7502af888f
Tutorial sys.argv example should not have interactive prompt (GH-94880)
2022-07-15 21:10:19 -05:00
3440d197a5
Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551)
...
Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
2022-07-05 11:16:10 +02:00
22b783aba0
Docs: Update SyntaxError message in REPL example for list comprehension (GH-93901)
2022-06-29 19:06:51 +02:00
4b854b7466
gh-61585: Clarify import scope in modules tutorial (GH-93455)
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-06-28 12:15:44 +02:00
cc0d5e568e
gh-94226: Remove the locale.format() function ( #94229 )
...
Remove the locale.format() function, deprecated in Python
3.7: use locale.format_string() instead.
Remove TestFormatPatternArg test case: it is irrelevant for
locale.format_string() which accepts complex formats.
2022-06-26 12:41:19 +02:00
7c439dca13
Closes gh-94152: Update pyvideo.org URL (GH-94075)
...
The URL is now https://pyvideo.org , which uses HTTPS and avoids a redirect.
2022-06-22 22:35:02 -05:00
8661c5053f
gh-94114: Remove obsolete reference to python.org mirrors (GH-94115)
...
* gh-94114
2022-06-22 09:55:06 -07:00
dd5cf84f24
Tutorial: specify match cases don't fall through (GH-93615)
2022-06-21 21:44:09 +02:00
51d673176a
gh-93240: clarify wording in IO tutorial (GH-93276)
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-06-21 21:40:11 +02:00
88f0d0c1e8
gh-89158: Add some REPL secondary prompt markers ( #93073 )
...
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.
2022-05-23 00:58:07 -04:00
3115c2c036
gh-91249: Remove .bat extension in documentation for when activating venv on Windows. (GH-92770)
2022-05-13 15:36:05 +01:00
859250cc55
gh-77521: Add link to builtin module names in modules tutorial ( #92438 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-05-08 12:30:38 -07:00
e851177536
Python 3.12.0a0
2022-05-08 03:40:52 +01:00
a79001ee16
gh-92368: Fix missing possessive apostrophe ( #92397 )
...
* Fix missing possessive apostrophe
2022-05-06 15:39:16 +02:00
614420df97
gh-85679: Recommend `encoding="utf-8"` in tutorial (GH-91778)
2022-05-02 17:25:05 +09:00
efb87b1090
gh-85757: Change wording from nested to inner (GH-91811)
...
#85757
https://docs.python.org/3/tutorial/datastructures.html#nested-list-comprehensions
I do think this is clearer, but I wonder if 'nested' should be kept though to get the terminology out there more often. So perhaps it could be something like 'inner (nested) listcomp' or 'nested (inner) listcomp' despite sounding a bit redundant
Automerge-Triggered-By: GH:rhettinger
2022-04-30 15:12:33 -07:00
f92bcfe6de
gh-89770: [PEP-678] add exception notes to tutorial (GH-30441)
2022-04-20 13:43:10 +01:00
efbc668183
gh-91541: Fix error in example in modules tutorial ( #91634 )
2022-04-17 14:17:04 -07:00
04f9658c59
gh-90449: Improve accuracy and readability of exceptions tutorial (GH-31899)
2022-04-13 21:45:33 +01:00
dc14e33eff
bpo-22295: use python -m pip rather than plain pip in more examples (GH-24003)
2022-04-09 14:37:01 -04:00
9ffe47df54
bpo-47189: What's New in 3.11: Faster CPython (GH-32235)
...
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Guido van Rossum <gvanrossum@users.noreply.github.com>
Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-04-06 19:38:25 +08:00
6db2db91b9
Follow PEP-8 guidelines in tutorial for standard library (GH-26127)
2022-04-03 15:31:03 -07:00
c62b944dfc
bpo-31582: Created a new documentation section describing sys.path initialization (GH-31082)
2022-03-23 17:29:40 +00:00
badb637c8c
docs: Don't use code formatting for emphasis (GH-30519)
2022-03-07 20:14:47 -08:00
35f55cc5c6
docs: Link `match` statement in tutorial (GH-31396)
...
Add a link to the `match` statement from its section in the tutorial.
This should be backported to 3.10.
[Initially submitted as #31395 but against the wrong branch. Thanks @Mariatta]
Automerge-Triggered-By: GH:Mariatta
2022-02-17 16:02:42 -08:00
fa90e48c53
[doc] Enhance readability by avoiding big blocks for small numbers. (GH-31157)
...
Initially reported by Gregory Jacob on the docs@ mailing list:
https://mail.python.org/archives/list/docs@python.org/thread/VPSFGLOZOHSPF7TGPOI65AOH25TCPSVR/
2022-02-06 13:44:04 +01:00
c590b581bb
bpo-46328: Add sys.exception() (GH-30514)
2022-01-13 12:35:58 +00:00
d24cd49acb
bpo-46270: Describe the `in` and `not in` operators as membership tests. (GH-30504)
2022-01-09 18:02:06 -08:00
9925e70e48
bpo-45292: [PEP-654] exception groups and except* documentation (GH-30158)
2022-01-06 19:05:34 +00:00
2db5613063
bpo-34538: Remove Exception subclassing from tutorial (GH-30361)
...
Remove the bit about subclassing exceptions.
Documentation PR can skip the NEWS label.
Automerge-Triggered-By: GH:iritkatriel
2022-01-03 14:52:09 -08:00
ac4eea2172
bpo-46079: Replace external link that is down for maintenance. (GH-30315)
2022-01-01 09:49:55 -08:00
c5d18a5014
Fix the output of built-in iter() function example in Iterators (Section 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>
2021-12-16 18:40:12 +08:00
1cbb88736c
bpo-46059: Clarify pattern-matching example in "control flow" docs (GH-30079)
...
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>
2021-12-14 23:04:29 +08:00
9f2f7e4226
bpo-45916: Use HTTPS link for The Perils of Floating Point (GH-29896)
2021-12-02 14:24:25 -06:00
7484a5c82a
Closes bpo-45712: Add missing word in control flow tutorial (GH-29460)
2021-11-08 10:51:01 -06:00
5a14f71fe8
bpo-34451: Document prompt and output toggle feature in html tutorial (GH-27105)
2021-10-21 12:19:20 +02:00
11b2ae7f5b
bpo-45442: Add deactivate step to venv tutorial. (GH-28981)
...
@vsajip Sorry for the trouble—made a [fairly significant] git error in the previous PR.
Have edited the patch as you had said in #28959 .
Automerge-Triggered-By: GH:vsajip
2021-10-15 14:24:25 -07:00
55b45bf707
bpo-38623: Add note about site module (site-packages) (GH-16974)
2021-09-23 23:39:58 +02:00
36122e1814
bpo-41203: Replace Mac OS X and OS X with macOS (GH-28515)
...
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>
2021-09-22 20:33:36 +03:00
7cba23164c
bpo-39452: Rewrite and expand __main__.rst ( #26883 )
...
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>
2021-08-24 19:01:41 +02:00
15a64d89a3
bpo-44966: Fix out-of-date traceback message (GH-27867)
2021-08-21 13:59:18 -05:00
599f5c8481
introduce omitted index default before using it (GH-27775)
2021-08-17 23:19:03 +02:00
ed524b4569
bpo-44907: Update error messages in tutorial examples (GH-27755)
2021-08-13 19:40:58 -04:00
e9a6f1b78b
bpo-41576: document BaseException in favor of bare except (GH-21917)
2021-08-06 22:44:15 +02:00
11749e2dc2
bpo-44740: Lowercase "internet" and "web" where appropriate. ( #27378 )
...
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-07-27 00:11:55 +02:00
2f49c9debc
bpo-40620: Clarify tutorial controlflow.rst ``range`` examples (GH-26919)
2021-06-27 20:27:20 +01:00
2f47d8dcc7
bpo-43927: Change 'IOError' to 'OSError' (GH-26289)
...
This is the last remaining instance, at least for this chapter, in 3.10 & 3.11.
2021-05-21 13:54:01 -04:00
4fdcc39f71
bpo-35765: Clarify references to "object x" in the JSON tutorial (GH-22411)
2021-05-18 14:56:01 -07:00
07797121cc
bpo-43729: Clarify comment in tutorial example (GH-25191)
2021-05-14 12:09:08 -07:00
6574334a68
bpo-40640: doc -- add missing ... in example of Continue ( #26055 )
...
Co-authored-by: Chas Belov <59780179+ChasBelov@users.noreply.github.com>
2021-05-12 11:23:03 +01:00
a0b9915a8b
bpo-32822: Add finally with return/break/continue to the tutorial ( #25600 )
...
This documents in the tutorial docs the behavior of a finally clause in
case it should re-raise an exception but contains a
return/break/continue statement.
2021-05-04 14:36:01 +02:00
bb3e0c240b
Python 3.11.0a0
2021-05-03 21:25:35 +01:00
2fd928c8c1
bpo-42589: Change URL for 'from' link when used in a raised exception (GH-23872)
...
Links for 'raise Exception from x' target to 'The raise statement' (7.8) section instead of 'The import statement' (7.11) section.
There are more modified links than in the bug report because I searched some other ones which can get the same improvement.
2021-04-29 11:02:40 -07:00
133705b85c
bpo-43777: Drop description of "pip search" command from tutorial (GH-25287)
2021-04-14 14:09:32 +09:00
f8775e4f72
bpo-43325: Add FAQ entry for identity tests (GH-25168)
2021-04-03 19:54:49 -07:00
a53e9a7cf5
bpo-39231: correct tutorial annotations section (GH-25029)
2021-03-27 13:20:58 -04:00
8d00462850
bpo-43319: Fixed the tutorial on venv about standard library (GH-24740)
...
In the [official tutorial on virtual environment](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments )
> This will create the tutorial-env directory if it doesn’t exist, and also create directories inside it containing a copy of the Python interpreter, **the standard library**, and various supporting files.
According to the actual behavior of `venv` and [PEP 405](https://www.python.org/dev/peps/pep-0405/#id15 )'s description about virtual environment, no standard library file is included in the virtual environment's directory.
Automerge-Triggered-By: GH:vsajip
2021-03-07 01:08:50 -08:00
a22bca6b1e
bpo-42128: Add documentation for pattern matching (PEP 634) ( #24664 )
...
This is a first edition, ready to go out with the implementation. We'll iterate during the rest of the period leading up to 3.10.0.
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Co-authored-by: Fidget-Spinner <28750310+Fidget-Spinner@users.noreply.github.com>
Co-authored-by: Brandt Bucher <brandt@python.org>
Co-authored-by: Raymond Hettinger <1623689+rhettinger@users.noreply.github.com>
Co-authored-by: Guido van Rossum <guido@python.org>
2021-02-28 20:08:38 -08:00
b30fcba3a8
bpo-43042: Augment tutorial sentence (GH-24514)
...
Calling same function also gets new local namespace.
2021-02-19 19:26:21 -05:00
89294e30ff
Doc: errors tutorial improvements (GH-16269)
...
Improvements:
- Improvements in how try clause works section
This suggestion is because the execution continues after *except*, not after *try* but before *except*. I guess this form more clear.
- Surrounding some keywords with \*...\*
For uniformity the highlighted terms
- Adjust the number of chars per line to 80
2021-01-30 22:07:11 -08:00
3f9fe23c05
bpo-42179: Clarify exception chaining (GH-23160)
...
* Update errors.rst
Clarify exception chaining behaviour and give a reference to the library documentation.
* Update errors.rst
Wording
* Update errors.rst
Spelling
* Update errors.rst
Remove mentioning of special attributes as folks think it's too much for beginners.
2020-12-15 18:47:26 -08:00
d41ec65ab7
bpo-42489: Fix the signature for list.sort() in the tutorial (GH-23538)
2020-11-28 16:53:39 +02:00
c8aaf71dde
bpo-17852: Doc: Fix the tutorial about closing files (GH-23135)
...
Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2020-11-27 09:41:32 +09:00
bde33e428d
bpo-42179: Doc/tutorial: Remove mention of __cause__ (GH-23162)
2020-11-06 11:45:01 +09:00
c8bb24166e
[doc] Update references to NumPy (GH-22458)
...
Numeric(al) Python to NumPy. It seems the old name hasn't been used for some time.
2020-10-01 16:22:14 -07:00
e8a2076e14
Revert "Fix all Python Cookbook links ( #22205 )" (GH-22424)
...
This commit reverts commit ac0333e1e1
2020-09-27 01:47:25 +01:00
ac0333e1e1
Fix all Python Cookbook links ( #22205 )
2020-09-15 21:13:26 +01:00
7bcc6456ad
bpo-41776: Revise example of "continue" in the tutorial documentation (GH-22234)
...
Revise example of "continue" in the tutorial documentation
2020-09-15 09:39:29 -04:00
0be7c216e1
Fix grammar in Doc/tutorial/controlflow.rst (GH-21885)
...
Automerge-Triggered-By: @csabella
2020-08-19 04:29:47 -07:00
bb0b08540c
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.
2020-08-14 12:20:05 +02:00
4f28f75dee
Fix repeated words in Classes tutorial (GH-21455)
...
The phrase "At any time during execution," was repeated twice.
Automerge-Triggered-By: @Mariatta
2020-07-13 18:26:23 -07:00
d12af71047
bpo-28681: Clarify multiple function names in the tutorial (GH-21340)
...
* improve control flow docs
* Add also
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2020-07-05 22:47:15 -03:00
9ed3cd8ba0
bpo-26205: Specify the number of nested scopes (GH-21324)
...
* 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>
2020-07-05 22:42:24 -03:00
eaca2aa117
Improve IO tutorial's "Old string formatting" section (GH-16251)
...
* 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>
2020-05-27 21:34:01 -04:00
6fad3e6b49
bpo-40552 Add 'users' variable in code sample (tutorial 4.2). (GH-19992)
...
* Add 'users' variable in code sample.
* 📜 🤖 Added by blurb_it.
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
2020-05-22 21:29:34 -03:00
d4fe098d1e
Python 3.10.0a0 (GH-20198)
2020-05-19 03:33:01 +01:00
eefd4e0333
bpo-39705 : sorted() tutorial example under looping techniques improved (GH-18999)
2020-05-17 18:32:34 -07:00
8bcfd31cc0
Change 'exception happened' to 'exception occurred' in two places ( #19767 )
2020-04-30 21:30:10 -07:00
e5e56328af
bpo-39869: Fix typo in 'Instance objects' section. (GH-18889)
2020-03-10 07:17:40 -07:00
3ed4d25158
Grammar fix in tutorial (GH-18425)
2020-02-09 19:57:46 -05:00
446463f8db
bpo-39534: Doc: Clarify return in finally (GH-18324)
2020-02-06 23:16:48 +01:00
5807efd4c3
bpo-38558: Link to further docs from walrus operator mention in tutorial (GH-16973)
2020-02-03 18:11:19 +01:00
7142df5ea2
bpo-39431: Also mention nonlocal in assignment quirk (GH-17375)
2020-01-23 13:09:21 -05:00
04c79d6088
bpo-38678: Improve argparse example in tutorial (GH-17207)
2019-11-17 22:06:19 -08:00
5e01a6542a
Update interpreter.rst (GH-17059)
...
Fixed what seemed to be a weird phrasing.
2019-11-05 14:20:38 +01:00
cb2cf06b0a
bpo-38558: Mention `:=` in conditions tutorial (GH-16919)
2019-10-25 17:20:05 -05:00
1ad7be2f16
bpo-38130: Fix error in explaining when an exception is re-raised (GH-16016)
...
Co-Authored-By: Ashwin Ramaswami <aramaswamis@gmail.com>
2019-09-26 11:09:05 +02:00
9ab6038fe8
Doc: Corrected syntax for return annotation (GH-16265)
...
Signed-off-by: Jason Plurad <pluradj@us.ibm.com>
2019-09-19 07:24:29 +02:00
b57481318e
bpo-37904: Edition on python tutorial - section 4 (GH-16169)
...
A little change on first paragraph of python tutorial to be more clearly
https://bugs.python.org/issue37904
Automerge-Triggered-By: @ericvsmith
2019-09-17 09:57:55 -07:00
f18242be16
Doc: Add link of GNU Readline library to interpreter tutorial (GH-16152)
2019-09-16 18:18:04 +02:00
b7af4e7565
Doc: remove duplicate word in controlflow tutorial (GH-16163)
2019-09-16 09:04:58 +02:00
Stanley
Shahriar Heidrich
Eddie Hebert
Serhiy Storchaka
partev
sand8089
Chenwei Xiao
Marco Buttu
Ned Batchelder
Cheryl Sabella
Victor Stinner
max
paulreece
Nicolas Haller
yashlad681
Pablo Galindo
gophra
Inada Naoki
Irit Katriel
180909
Ville Skyttä
Ken Jin
Bob Kline
Russel Webber
William Andrea
Julien Palard
Raymond Hettinger
Hugo van Kemenade
Vivek Vashist
Alex Waygood
Zachary Ware
Thomas
srinivasan
Peter Bittner
Jack DeVries
Jefferson Oliveira
meowmeowmeowcat
Thomas Grainger
Mariusz Felisiak
Terry Jan Reedy
Zackery Spytz
Erlend Egeberg Aasland
Irit Katriel
Roberto Hueso
sblondon
cmhzc
Daniel F Moisset
Adorilson Bezerra
Vladimir
Volker-Weissmann
Andre Delfino
Neeraj Samtani
Denis Ovsienko
Paul McMillan
Joannah Nanjekye
Antoine
Rahul Kumaresan
Noah Doersing
Don Kirkby
Shanavas M
Jules Lasne (jlasne)
Ammar Askar
Mohammad Dehghan
Jason Plurad
Diego Alberto Barriga Martínez