780 Commits

Author SHA1 Message Date
Miss Islington (bot)
7f263d4444
[3.13] gh-127265: Remove single quotes from 'arrow's in tutorial/errors.rst (GH-127269)
(cherry picked from commit 26ff32b30553e1f7b0cc822835ad2da8890c180c)

Co-authored-by: funkyrailroad <funkyrailroad@users.noreply.github.com>
2024-11-25 21:39:59 +00:00
Miss Islington (bot)
5f4218418b
[3.13] Prefer "similar" over "equivalent" in tutorial (GH-125343) (GH-125372)
Prefer "similar" over "equivalent" in tutorial (GH-125343)

In the datastructures tutorial doc, some operations are described as
"equivalent to" others. This has led to some user-confusion -- at
least in the Discourse forums -- about cases in which the operations
differ.

This change doesn't systematically eliminate the word "equivalent"
from the tutorial. It just substitutes "similar to" in several cases
in which "equivalent to" could mislead users into expecting exact
equivalence.
(cherry picked from commit 4a2282b0679bbf7b7fbd36aae1b1565145238961)

Co-authored-by: Stephen Rosen <sirosen@globus.org>
2024-10-30 13:33:20 -07:00
Miss Islington (bot)
210bd2a50d
[3.13] gh-85583: Add f-string index in tutorial/inputoutput.rst (GH-21681) (GH-126191)
gh-85583: Add f-string index in tutorial/inputoutput.rst  (GH-21681)

* bpo-41411 fstring index in tutorial/inputoutput

To assist in searching for fstrings I have added an index

* Add newline

---------

(cherry picked from commit a3443c0e22a8623afe4c0518433b28afbc3a6df6)

Co-authored-by: amaajemyfren <32741226+amaajemyfren@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2024-10-30 10:35:10 -07:00
Miss Islington (bot)
de9ff23ea1
[3.13] docs: restore an anchor to for/else (GH-126154) (#126159)
docs: restore an anchor to for/else (GH-126154)
(cherry picked from commit 2d9d10179ff3f13029bf4430e62c455a839987ca)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2024-10-30 08:16:33 +00:00
Miss Islington (bot)
f521142b47
[3.13] Fix a typo in `Doc/tutorial/errors.rst` exception output (GH-126001) (#126009)
Fix a typo in ``Doc/tutorial/errors.rst`` exception output (GH-126001)
(cherry picked from commit a78d5b32429e2399178ac838e0e62b2bd62c0af9)

Co-authored-by: Bogdana Vereha <bogdanap@github.com>
2024-10-26 15:32:37 +00:00
Miss Islington (bot)
ca9bbafb49
[3.13] gh-125615: Fix grammar nit in tutorial's interactive interpreter appendix (GH-125619)
Replace "without ... nor" with "with neither ... nor"

(cherry picked from commit aab3210271136ad8e8fecd927b806602c463e1f2)

Authored-by: Cornelius Roemer <cornelius.roemer@gmail.com>
2024-10-16 20:58:49 +00:00
Miss Islington (bot)
c9ead96249
[3.13] gh-125383: Update fib function comment for accuracy (GH-125386) (#125395)
gh-125383: Update `fib` function comment for accuracy (GH-125386)

`Doc/tutorial/controlflow.rst`: fix comment for `fib` function
(cherry picked from commit 283ea5f3b2b6a18605b8598a979afe263b0f21ce)

Co-authored-by: Wulian <xiguawulian@gmail.com>
2024-10-13 11:16:23 +00:00
Miss Islington (bot)
a314026cfe
[3.13] Doc: Fix a typo in "Function Examples" in the control-flow tutorial (GH-125338) (#125341)
Doc: Fix a typo in "Function Examples" in the control-flow tutorial (GH-125338)
(cherry picked from commit 5a074aab845f82f4a150c27b905dae05c337d381)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-10-12 00:45:50 +00:00
Alex Waygood
aa4da1e468
[3.13] gh-101100: Consolidate documentation on ModuleType attributes (#124709) (#125208)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Barry Warsaw <barry@python.org>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-10-09 20:03:30 +01:00
Miss Islington (bot)
12bb9ed279
[3.13] Docs: make a tutorial example more precise (GH-125066) (#125078)
(cherry picked from commit 6e3c70c61bf961e55e9912a31ca11f61c8e2cd0c)
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2024-10-08 02:15:42 +01:00
Miss Islington (bot)
ac3e6f801b
[3.13] Docs: for for/else clarify that return or raise also skip the else (GH-124591) (#124659)
Docs: for for/else clarify that return or raise also skip the else (GH-124591)

(cherry picked from commit 5329d1b74a86b3a22ff36f7976bfe720ee06d10d)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-09-27 11:08:56 -07:00
Alex Waygood
9f2e6ca199
[3.13] gh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs (#124480) (#124556) 2024-09-25 17:29:48 -07:00
Miss Islington (bot)
56467a66d2
[3.13] For-else deserves its own section in the tutorial (GH-123946) (#124564)
For-else deserves its own section in the tutorial (GH-123946)

* For-else deserves its own section in the tutorial

* remove mention of unrolling the loop

* Update Doc/tutorial/controlflow.rst



---------

(cherry picked from commit ffdc80e93d9d947531fa0123e5b392c6f1fd9136)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-09-25 17:10:15 -07:00
Miss Islington (bot)
72139f276e
[3.13] Update to 3.13 the output of exceptions raised (GH-123888) (#124055)
Update to 3.13 the output of exceptions raised (GH-123888)
(cherry picked from commit 39612103dd9894abf8c2ebbe2fc183d65f1b51b1)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-09-23 10:53:31 -07:00
Wei-Hsiang (Matt) Wang
9f5f2b7128
[3.13] gh-123492: Remove unnecessary :func: parentheses (gh-123493) (#123513) 2024-08-30 20:14:48 +03:00
Miss Islington (bot)
009f9efe65
[3.13] GH-109975: Copyedit 3.13 What's New: New Features (GH-122990) (#123032)
GH-109975: Copyedit 3.13 What's New: New Features (GH-122990)
(cherry picked from commit b106cf8d978b32b04a4394973b850ef2a62cbcc4)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Brandt Bucher <brandtbucher@gmail.com>
2024-08-15 09:25:33 +00:00
Miss Islington (bot)
fcc7c4ea66
[3.13] gh-122944: Fix incorrect prompt strings in the Python Tutorial (GH-122949) (#122954)
gh-122944: Fix incorrect prompt strings in the Python Tutorial (GH-122949)

In the REPL, top level comments are followed by a primary, not secondary prompt.
Fix the places in the in the tutorial that use the latter.
(cherry picked from commit be90648fb2de58b148dcc7553a08ca646911baf2)

Co-authored-by: Damien <81557462+Damien-Chen@users.noreply.github.com>
2024-08-12 18:56:36 +00:00
Serhiy Storchaka
a45d9051ed
[3.13] gh-121905: Consistently use "floating-point" instead of "floating point" (GH-121907) (GH-122012)
(cherry picked from commit 1a0c7b9ba48a2dffb70bb0c7327abae1d3e87356)
2024-07-19 09:13:08 +00:00
Miss Islington (bot)
4af9c05e78
[3.13] gh-120452: improve documentation about private name mangling (GH-120451) (#121715)
gh-120452: improve documentation about private name mangling (GH-120451)
(cherry picked from commit f4d6e45c1e7161878b36ef9e876ca3e44b80a97d)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-07-13 15:21:30 +00:00
Miss Islington (bot)
f0788cb419
[3.13] gh-120345: Fix incorrect use of the :class: role with the "()" suffix (GH-120347) (GH-120411)
* Remove "()" when refer to a class as a type.
* Use :func: when refer to a callable.
* Fix reference to the datetime.astimezone() method.
(cherry picked from commit 92c9c6ae147e1e658bbc8d454f8c7b2c4dea31d1)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-06-12 14:51:35 +00:00
Miss Islington (bot)
a2003bd195
[3.13] gh-110383: Improve 'old string formatting' text in tutorial (GH-120219) (#120229)
(cherry picked from commit 225aab7f70d804174cc3a75bc04a5bb1545e5adb)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-06-07 13:53:35 +00:00
Miss Islington (bot)
edb6883ef3
[3.13] gh-119016: Remove outdated sentences from the "classes" tutorial (GH-119130) (#119925)
Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-06-01 21:35:03 +00:00
Miss Islington (bot)
3f0198d927
[3.13] docs: fix a few typos identified by codespell (GH-119516) (#119570)
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2024-05-26 08:20:37 +00:00
Miss Islington (bot)
11ca1d9d53
[3.13] GH-110383: Improve Tutorial for Input Ouput (GH-119230) (GH-119326)
GH-110383: Improve Tutorial for Input Ouput (GH-119230)

(cherry picked from commit 9db2fd7edaa9d03e8c649c3bb0e8d963233cde22)

Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: edson duarte <eduarte.uatach@gmail.com>
2024-05-21 19:54:26 +02:00
Miss Islington (bot)
1bb3a9df1b
[3.13] gh-119078: Clarify venv tutorial (GH-119129) (GH-119142)
(cherry picked from commit 0f5e8bed636c2f29701e5a1965d1b088d33abbf0)
2024-05-18 13:06:23 +01:00
Miss Islington (bot)
8f31af68d0
[3.13] Format None, True, False and NotImplemented as literals (GH-118758) (GH-118792)
(cherry picked from commit 05c2fe1acda9ea5a57061642c36e8b73bb4fbba4)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-05-08 19:55:12 +00:00
Kerim Kabirov
a855f824a2
Remove Python 3.5 hardcoded version in the tutorial appendix (GH-117612) 2024-05-07 15:28:16 +02:00
Pablo Galindo Salgado
f27f8c790a
gh-111201: A new Python REPL (GH-111567)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Marta Gómez Macías <mgmacias@google.com>
Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-05-05 21:32:23 +02:00
Hugo van Kemenade
7d0be7aea5
Add 'The Python 2.3 Method Resolution Order' (#116435) 2024-04-15 13:01:15 +03:00
Nice Zombies
a05068db0c
gh-117597: Clarify exception handling in the tutorial (#117681) 2024-04-09 20:59:45 +00:00
Terry Jan Reedy
3e45030076
gh-116563: Update tutorial error example (#116569)
There now may be multiple carets pointing at a token
rather than just a character.  Fix the sentence about
possible causes.
2024-03-11 18:01:08 -04:00
Kerim Kabirov
45a92436c5
GH-116271 Docs: provide clarification for object assignments in the Tutorial section (#116283)
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-03-04 12:22:13 +00:00
Hugo van Kemenade
46245b0d83
Docs: Use substitutions instead of manual version updates (#115416) 2024-02-13 23:55:00 -07:00
srinivasan
57c3e775df
gh-114648: Add IndexError exception to tutorial datastructures list.pop entry (#114681)
Remove redundant explanation of optional argument.
2024-01-31 22:46:49 -05:00
Terry Jan Reedy
31a2543c80
gh-114069: Revise Tutorial Methods paragraph (#114127)
Remove excess words in the first and third sentences.
2024-01-16 11:33:05 -05:00
Andrew Zipperer
32f3684b8f
Tutorial: Clarify 'nonzero exit status' in the appendix (#112039) 2024-01-12 22:42:51 +00:00
Unique-Usman
d71fcdee0f
gh-113208: Mention namespace packages don't require __init__.py (#113209)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-12-19 10:39:57 +02:00
jeremy-dolan
fb4cb7ce31
gh-113113: doc: use less ambiguously named variable (gh-113114) 2023-12-14 15:40:24 +00:00
Alex Waygood
ed21d0c1f4
gh-101100: Improve documentation for attributes on instance methods (#112832) 2023-12-08 13:18:53 +00:00
Marco Aurélio A. Barbosa
c27b09c813
Fix link to 'The Perils of Floating Point', on the tutorial (GH-112499)
Use author link to 'The Perils of Floating Point'.
2023-12-03 17:14:14 +02:00
Unique-Usman
a6d25de375
gh-110383: Explained which error message is generated when there is an unhandled exception (#111574)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-11-19 05:20:10 -07:00
zipperer
2f2a0a3a6c
Add detail to comment on range of random.random() (gh-111868)
---------

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2023-11-09 08:58:04 -06:00
Zack Cerza
8a158a753c
gh-111406: Fix broken link to bpython's site (#111407) 2023-10-27 18:36:22 +00:00
Maciej Olko
663cf513b0
gh-101100: Fix Sphinx warning in tutorial/introduction.rst (#111173) 2023-10-22 14:53:17 +03:00
partev
892ee72b36
gh-110534 fix a URL redirect to wikipedia article on Fibonacci numbers (#110535) 2023-10-09 00:44:15 -04:00
zipperer
8e56d551ce
Update floatingpoint.rst (#110509)
This commit removes a ':'. I believe the extra colon causes a display error.

What I believe to be an error:
Above this expression
`round(math.pi, ndigits=2) == round(22 / 7, ndigits=2)`
the page displays `.. doctest::`.

What I observed:
After I remove the extra colon, the page does not display `.. doctest::`
2023-10-07 17:07:36 -07:00
Maciej Olko
8898a8683b
gh-101100: Fix Sphinx warnings in tutorial/controlflow.rst (#109424)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-09-29 11:27:43 +03:00
Nikita Sobolev
3047f09490
gh-101100: Fix sphinx warnings in tutorial/appendix.rst (#108750)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-01 10:57:34 +00:00
Nikita Sobolev
e775601ef1
gh-101100: Fix sphinx warnings in tutorial/classes.rst (#108746) 2023-09-01 13:44:43 +03:00
Serhiy Storchaka
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