e775601ef1
gh-101100: Fix sphinx warnings in `tutorial/classes.rst` ( #108746 )
2023-09-01 13:44:43 +03:00
622ddc4167
Improve references in the tutorial (GH-108069)
...
* Use full qualified names for references (even if they do not work now,
they will work in future).
* Silence references to examples.
2023-08-21 13:41:01 +03:00
33e6e3fec0
GH-107987: Remove the Distributing Python Modules guide ( #108016 )
2023-08-17 13:01:14 +03:00
f2d07d3289
gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386)
2023-07-29 08:48:10 +03:00
2cf99026d6
gh-107017: Change Chapter Strings to Texts in the Introduction chapter. ( #107104 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-07-24 05:55:57 +00:00
e59da0c4f2
gh-107017: Analolgy to Pascal and C replaced. ( #107025 )
...
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-07-23 06:07:24 -06:00
680f3e1591
gh-71261: Add paragraph on shadowing submodules with star imports ( #107004 )
2023-07-23 03:00:42 -06:00
9629d4442e
gh-107017: removed mention that C does it the same way ( #107020 )
2023-07-23 02:57:52 -06:00
ed491d9f78
Reformat code block to make it easier to read ( #106965 )
2023-07-22 14:19:30 +02:00
7aa89e505d
gh-106780: Add __match_args__ to tutorial example ( #106784 )
...
Add Point definition with this attribute before example
that needs it.
2023-07-16 23:36:03 -04:00
d0b7e18262
gh-106625 : Add missing code to tutorial 4.6 example ( #106623 )
...
* Added missing import statement.
* Update Doc/tutorial/controlflow.rst
* Update Doc/tutorial/controlflow.rst
* Update controlflow.rst
* Make point regular class with __init__.
---------
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-07-11 13:22:07 -04:00
38aa89a52e
Doc: Add missing ref labels to exception groups/notes sections ( #106465 )
2023-07-05 23:41:04 -06:00
2cf04e455d
gh-104479: Update outdated tutorial floating-point reference ( #104681 )
2023-05-25 23:26:16 -07:00
500b0f4814
Python 3.13.0a0
2023-05-22 21:15:32 +02:00
f5088006ca
GH-97950: Use new-style index directive ('builtin') ( #104164 )
...
* Uncomment builtin removal in pairindextypes
* Use new-style index directive ('builtin') - C API
* Use new-style index directive ('builtin') - Extending
* Use new-style index directive ('builtin') - Library
* Use new-style index directive ('builtin') - Reference
* Use new-style index directive ('builtin') - Tutorial
2023-05-06 06:54:08 +03:00
55d50d147c
GH-97950: Use new-style index directive ('statement') ( #104162 )
2023-05-04 13:48:45 +03:00
6ab463684b
GH-97950: Use new-style index directive ('object') ( #104158 )
...
* Uncomment object removal in pairindextypes
* Use new-style index directive ('object') - C API
* Use new-style index directive ('object') - Library
* Use new-style index directive ('object') - Reference
* Use new-style index directive ('object') - Tutorial
2023-05-04 13:04:41 +03:00
d0122372f2
GH-97950: Use new-style index directive ('module') ( #103996 )
...
* Use new-style index directive ('module') - C API
* Use new-style index directive ('module') - Library
* Use new-style index directive ('module') - Reference
* Use new-style index directive ('module') - Tutorial
* Uncomment module removal in pairindextypes
* Use new-style index directive ('module') - C API
* Use new-style index directive ('module') - Library
* Use new-style index directive ('module') - Reference
2023-05-04 10:17:12 +02:00
8709697292
[doc] Fix error in tutorial example: type(exc) is the type rather than the instance ( #102751 )
2023-03-22 18:43:41 +00:00
0a539b5db3
gh-102703: Fix typo in modules tutorial documentation (GH-102707)
...
**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 ...
2023-03-14 17:03:43 -07:00
80abd62647
gh-102354: change python3 to python in docs examples ( #102696 )
2023-03-14 12:40:12 -06:00
3b264df470
Misc improvements to the float tutorial (GH-102052)
2023-02-19 13:21:37 -06:00
32df540635
gh-100425: Update tutorial docs related to sum() accuracy (FH-101854)
2023-02-19 10:39:03 -06:00
45d014e03b
docs: replace PyPI description with link ( #101506 )
2023-02-03 12:53:11 +05:30
98308dbeb1
gh-100633 Tutorial: Fix dataclasses import ( #100638 )
...
import dataclass not dataclasses from dataclasses
2022-12-31 10:23:18 +00:00
b95b1b3b25
gh-55688: Add note about ending backslashes for raw strings ( #94768 )
...
Co-authored-by: hauntsaninja <hauntsaninja@gmail.com>
2022-12-28 00:30:42 -05:00
00afa5066b
gh-99908: Tutorial: Modernize the 'data-record class' example ( #100499 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-12-24 15:23:24 +00:00
5d84966cce
GH-100425: Improve accuracy of builtin sum() for float inputs (GH-100426)
2022-12-23 14:35:58 -08:00
2cd5146f27
Fix typo in introduction.rst ( #100266 )
2022-12-16 15:56:30 +05:30
70be5e42f6
gh-70393: Clarify mention of "middle" scope ( #98839 )
2022-12-11 20:15:55 -08:00
586b07e1f9
[doc] fix typo (GH-99143)
2022-11-05 21:03:29 +00:00
f042646595
Doc: use "unnumbered" footnotes ( #98954 )
...
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.
2022-11-01 13:25:33 +00:00
d22bde983e
Missing PS1 prompt in tutorial example (GH-98921)
2022-10-31 21:24:26 -05:00
5f8ca1b796
tutorial: remove "with single quotes" ( #98204 )
...
Closes #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.
2022-10-12 09:00:51 -07:00
571e23d991
doc: remove a misleading statement. (GH-98093)
2022-10-10 09:01:16 +02:00
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
Nikita Sobolev
Serhiy Storchaka
Adam Turner
TommyUnreal
wulmer
Jakub Červinka
Joe Kaufeld
Terry Jan Reedy
RustyNail
C.A.M. Gerlach
Mark Dickinson
Thomas Wouters
Jens-Hilmar Bradt
Robert Prater (B. Eng)
Paul Watson
Raymond Hettinger
neuralstring
François Magimel
Owain Davies
Stanley
JosephSBoyle
Mikhail Berkov
Shantanu
Doj
Manuel Kaufmann
Jelle Zijlstra
Julien Palard
Shahriar Heidrich
Eddie Hebert
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
Hugo van Kemenade
Vivek Vashist
Alex Waygood
Zachary Ware
Thomas
srinivasan
Peter Bittner
Jack DeVries
Jefferson Oliveira
meowmeowmeowcat
Thomas Grainger
Mariusz Felisiak
Zackery Spytz
Erlend Egeberg Aasland
Irit Katriel
Roberto Hueso
sblondon