Commit graph

761 commits

Author SHA1 Message Date
Wei-Hsiang (Matt) Wang
d5abd02f36
[3.12] gh-123492: Remove unnecessary :func: parentheses (gh-123493) (#123512) 2024-08-30 20:09:55 +03:00
Miss Islington (bot)
cd69085366
[3.12] gh-122944: Fix incorrect prompt strings in the Python Tutorial (GH-122949) (#122955)
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 be90648fb2)

Co-authored-by: Damien <81557462+Damien-Chen@users.noreply.github.com>
2024-08-12 18:43:53 +00:00
Serhiy Storchaka
39dea212f4
[3.12] gh-121905: Consistently use "floating-point" instead of "floating point" (GH-121907) (GH-122013)
(cherry picked from commit 1a0c7b9ba4)
2024-07-19 09:08:33 +00:00
Miss Islington (bot)
20d145512a
[3.12] gh-120452: improve documentation about private name mangling (GH-120451) (#121716)
gh-120452: improve documentation about private name mangling (GH-120451)
(cherry picked from commit f4d6e45c1e)

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:11:33 +00:00
Miss Islington (bot)
319233f137
[3.12] gh-120345: Fix incorrect use of the :class: role with the "()" suffix (GH-120347) (GH-120412)
* 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 92c9c6ae14)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-06-12 14:42:06 +00:00
Miss Islington (bot)
9cdf696075
[3.12] gh-110383: Improve 'old string formatting' text in tutorial (GH-120219) (#120230)
(cherry picked from commit 225aab7f70)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-06-07 13:43:59 +00:00
Miss Islington (bot)
e57a4a19a1
[3.12] gh-119016: Remove outdated sentences from the "classes" tutorial (GH-119130) (#119926)
Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-06-01 21:26:07 +00:00
Hugo van Kemenade
7f86c769db
[3.12] docs: fix a few typos identified by codespell (GH-119516) (#119571)
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2024-05-26 08:15:57 +00:00
Miss Islington (bot)
4dfba854ec
[3.12] GH-110383: Improve Tutorial for Input Ouput (GH-119230) (GH-119327)
GH-110383: Improve Tutorial for Input Ouput (GH-119230)

(cherry picked from commit 9db2fd7eda)

Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: edson duarte <eduarte.uatach@gmail.com>
2024-05-21 19:54:20 +02:00
Miss Islington (bot)
bb44a827f1
[3.12] gh-119078: Clarify venv tutorial (GH-119129) (GH-119141)
(cherry picked from commit 0f5e8bed63)
2024-05-18 12:54:40 +01:00
Serhiy Storchaka
530c3bb271
[3.12] Format None, True, False and NotImplemented as literals (GH-118758) (GH-118794)
(cherry picked from commit 05c2fe1acd)
2024-05-08 19:55:13 +00:00
Miss Islington (bot)
efbc8c78c5
[3.12] Remove Python 3.5 hardcoded version in the tutorial appendix (GH-117612) (GH-118707)
Remove Python 3.5 hardcoded version in the tutorial appendix (GH-117612)
(cherry picked from commit a855f824a2)

Co-authored-by: Kerim Kabirov <the.privat33r+gh@pm.me>
2024-05-07 13:35:09 +00:00
Hugo van Kemenade
a844e83b06
[3.12] Add 'The Python 2.3 Method Resolution Order' (GH-116435) (#117885)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-04-15 14:14:16 +03:00
Miss Islington (bot)
e46fd7257a
[3.12] gh-117597: Clarify exception handling in the tutorial (GH-117681) (#117700)
(cherry picked from commit a05068db0c)

Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
2024-04-09 21:06:35 +00:00
Miss Islington (bot)
1231697697
[3.12] gh-116563: Update tutorial error example (GH-116569) (#116624)
There now may be multiple carets pointing at a token
rather than just a character.  Fix the sentence about
possible causes.
(cherry picked from commit 3e45030076)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-03-11 22:11:44 +00:00
Miss Islington (bot)
f6de98407d
[3.12] GH-116271 Docs: provide clarification for object assignments in the Tutorial section (GH-116283) (#116305)
Co-authored-by: Kerim Kabirov <39376984+Privat33r-dev@users.noreply.github.com>
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-03-04 12:28:43 +00:00
Miss Islington (bot)
09b8b14e05
[3.12] gh-114648: Add IndexError exception to tutorial datastructures list.pop entry (GH-114681) (#114841)
Remove redundant explanation of optional argument.
(cherry picked from commit 57c3e775df)

Co-authored-by: srinivasan <shivnaren@gmail.com>
2024-02-01 03:52:58 +00:00
Miss Islington (bot)
3eeab87feb
[3.12] gh-114069: Revise Tutorial Methods paragraph (GH-114127) (#114131)
gh-114069: Revise Tutorial Methods paragraph (GH-114127)

Remove excess words in the first and third sentences.
(cherry picked from commit 31a2543c80)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-01-16 16:43:20 +00:00
Miss Islington (bot)
68d1e30c94
[3.12] Tutorial: Clarify 'nonzero exit status' in the appendix (GH-112039) (#113999)
Tutorial: Clarify 'nonzero exit status' in the appendix (GH-112039)
(cherry picked from commit 32f3684b8f)

Co-authored-by: Andrew Zipperer <47086307+zipperer@users.noreply.github.com>
2024-01-12 22:48:59 +00:00
Miss Islington (bot)
ca5a5231d3
[3.12] gh-113208: Mention namespace packages don't require __init__.py (GH-113209) (#113276)
Co-authored-by: Unique-Usman <86585626+Unique-Usman@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-12-19 08:46:13 +00:00
Miss Islington (bot)
a157881dbc
[3.12] gh-113113: doc: use less ambiguously named variable (gh-113114) (gh-113122) 2023-12-14 16:25:07 +00:00
Miss Islington (bot)
b39e90e4d1
[3.12] gh-101100: Improve documentation for attributes on instance methods (GH-112832) (#112872)
gh-101100: Improve documentation for attributes on instance methods (GH-112832)
(cherry picked from commit ed21d0c1f4)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-08 13:25:52 +00:00
Miss Islington (bot)
b3b2706cad
[3.12] Fix link to 'The Perils of Floating Point', on the tutorial (GH-112499) (GH-112664)
Use author link to 'The Perils of Floating Point'.
(cherry picked from commit c27b09c813)

Co-authored-by: Marco Aurélio A. Barbosa <aureliobarbosa@gmail.com>
2023-12-03 15:20:13 +00:00
Miss Islington (bot)
dedbd266d3
[3.12] gh-110383: Explained which error message is generated when there is an unhandled exception (GH-111574) (#112264)
Co-authored-by: Unique-Usman <86585626+Unique-Usman@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-11-19 05:29:24 -07:00
Miss Islington (bot)
754fda88d1
[3.12] gh-111406: Fix broken link to bpython's site (GH-111407) (#111408)
gh-111406: Fix broken link to bpython's site (GH-111407)
(cherry picked from commit 8a158a753c)

Co-authored-by: Zack Cerza <zack@cerza.org>
2023-10-27 18:44:33 +00:00
Miss Islington (bot)
f2f89bf1c1
[3.12] gh-101100: Fix Sphinx warning in tutorial/introduction.rst (GH-111173) (#111175)
gh-101100: Fix Sphinx warning in `tutorial/introduction.rst` (GH-111173)
(cherry picked from commit 663cf513b0)

Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
2023-10-22 12:01:24 +00:00
Miss Islington (bot)
fb8c0415a2
[3.12] gh-110534 fix a URL redirect to wikipedia article on Fibonacci numbers (GH-110535) (#110536)
gh-110534 fix a URL redirect to wikipedia article on Fibonacci numbers (GH-110535)
(cherry picked from commit 892ee72b36)

Co-authored-by: partev <petrosyan@gmail.com>
2023-10-09 04:52:36 +00:00
Miss Islington (bot)
96e42d2f8d
[3.12] Update floatingpoint.rst (GH-110509) (#110513)
Update floatingpoint.rst (GH-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::`
(cherry picked from commit 8e56d551ce)

Co-authored-by: zipperer <47086307+zipperer@users.noreply.github.com>
2023-10-08 00:18:39 +00:00
Miss Islington (bot)
c89844aaec
[3.12] gh-101100: Fix Sphinx warnings in tutorial/controlflow.rst (GH-109424) (#110084)
gh-101100: Fix Sphinx warnings in `tutorial/controlflow.rst` (GH-109424)
(cherry picked from commit 8898a8683b)

Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-09-29 15:29:39 +02:00
Hugo van Kemenade
f58617a3bc
[3.12] gh-101100: Fix sphinx warnings in tutorial/appendix.rst (GH-108750) (#108759)
(cherry picked from commit 3047f09490)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-09-02 23:42:40 +02:00
Miss Islington (bot)
712994e1ab
[3.12] gh-101100: Fix sphinx warnings in tutorial/classes.rst (GH-108746) (#108756)
gh-101100: Fix sphinx warnings in `tutorial/classes.rst` (GH-108746)
(cherry picked from commit e775601ef1)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-09-01 15:33:36 +02:00
Miss Islington (bot)
f798a6360b
[3.12] Improve references in the tutorial (GH-108069) (#108203)
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.
(cherry picked from commit 622ddc4167)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-08-21 13:20:21 +02:00
Miss Islington (bot)
2576303007
[3.12] GH-107987: Remove the Distributing Python Modules guide (GH-108016) (#108081)
GH-107987: Remove the Distributing Python Modules guide (GH-108016)
(cherry picked from commit 33e6e3fec0)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-17 12:50:46 +02:00
Serhiy Storchaka
d514e1439f
[3.12] gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386) (GH-107419)
(cherry picked from commit f2d07d3289)
2023-07-29 09:16:27 +03:00
Miss Islington (bot)
beb5514826
[3.12] gh-107017: Change Chapter Strings to Texts in the Introduction chapter. (GH-107104) (#107167)
Co-authored-by: TommyUnreal <45427816+TommyUnreal@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-07-24 16:30:22 +00:00
Miss Islington (bot)
e02ddb33ce
[3.12] gh-107017: Analolgy to Pascal and C replaced. (GH-107025) (#107124)
(cherry picked from commit e59da0c4f2)

Co-authored-by: TommyUnreal <45427816+TommyUnreal@users.noreply.github.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-07-23 13:59:50 +00:00
Miss Islington (bot)
98626c3c71
[3.12] gh-107017: removed mention that C does it the same way (GH-107020) (#107097)
Co-authored-by: Jakub Červinka <cervinka.jakub.1989@gmail.com>
2023-07-23 03:11:26 -06:00
Miss Islington (bot)
a80721b83d
[3.12] gh-71261: Add paragraph on shadowing submodules with star imports (GH-107004) (#107100)
Co-authored-by: wulmer <wulmer@users.noreply.github.com>
2023-07-23 09:01:24 +00:00
Miss Islington (bot)
e7757ab9e1
[3.12] Reformat code block to make it easier to read (GH-106965) (#107010)
(cherry picked from commit ed491d9f78)

Co-authored-by: Joe Kaufeld <opensource@joekaufeld.com>
2023-07-22 14:54:13 +02:00
Miss Islington (bot)
11b3d38310
[3.12] gh-106780: Add __match_args__ to tutorial example (GH-106784) (#106819)
Add Point definition with this attribute before example
that needs it.
(cherry picked from commit 7aa89e505d)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-07-17 04:15:35 -04:00
Miss Islington (bot)
139e7ac7c2
[3.12] gh-106625 : Add missing code to tutorial 4.6 example (GH-106623) (#106636)
(cherry picked from commit d0b7e18262)

Co-authored-by: RustyNail <takonoyawarakaage@yahoo.co.jp>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-07-11 13:40:59 -04:00
Miss Islington (bot)
84cda268bd
[3.12] Doc: Add missing ref labels to exception groups/notes sections (GH-106465) (#106473)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-07-05 23:51:30 -06:00
Miss Islington (bot)
bd2cc41d38
[3.12] gh-104479: Update outdated tutorial floating-point reference (GH-104681) (#104960)
(cherry picked from commit 2cf04e455d)

Co-authored-by: Mark Dickinson <dickinsm@gmail.com>
2023-05-25 23:30:12 -07:00
Adam Turner
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
Adam Turner
55d50d147c
GH-97950: Use new-style index directive ('statement') (#104162) 2023-05-04 13:48:45 +03:00
Adam Turner
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
Adam Turner
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
Jens-Hilmar Bradt
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
Robert Prater (B. Eng)
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
Paul Watson
80abd62647
gh-102354: change python3 to python in docs examples (#102696) 2023-03-14 12:40:12 -06:00