Commit graph

26124 commits

Author SHA1 Message Date
Miss Islington (bot)
a166cb4131
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 ...
(cherry picked from commit 0a539b5db3)

Co-authored-by: Robert Prater (B. Eng) <robcprater@gmail.com>
2023-03-14 17:11:56 -07:00
Miss Islington (bot)
738dde303b
[3.11] gh-102354: change python3 to python in docs examples (GH-102696) (#102697)
gh-102354: change python3 to python in docs examples (GH-102696)
(cherry picked from commit 80abd62647)

Co-authored-by: Paul Watson <paul.hermeneutic@gmail.com>
2023-03-14 12:52:33 -06:00
Miss Islington (bot)
1f7eb8fe6c
gh-100315: clarification to __slots__ docs. (GH-102621)
refer to tp_itemsize in discussion on "variable-length" built-in types
(cherry picked from commit 88c262c086)

Co-authored-by: T <tnie@tuta.io>
2023-03-14 02:32:09 -07:00
Miss Islington (bot)
0f46d42eb9
doc: Remove a duplicate 'versionchanged' in library/asyncio-task (gh-102677)
(cherry picked from commit 7bdb331b67)

Co-authored-by: Joongi Kim <me@daybreaker.info>
2023-03-13 19:26:11 -07:00
Miss Islington (bot)
43f8082b1c
gh-102627: Replace address pointing toward malicious web page (GH-102630)
* Replace known bad address pointing toward a malicious web page.

(cherry picked from commit 61479d4684)

Co-authored-by: Blind4Basics <32236948+Blind4Basics@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-03-13 15:43:16 -07:00
Alex Waygood
a4fcd06c50
[3.11] Fix duplicated words in the docs (#102644)
(cherry-picked from commit f6ca71a422)

With grep utility found some duplicated words

Co-authored-by: Виталий Дмитриев <vitaldmit@bk.ru>
2023-03-13 14:31:50 +00:00
Miss Islington (bot)
c39a1d0ba9
gh-101100: Fix Sphinx warnings in turtle module (GH-102340)
(cherry picked from commit 78e4e6c3d7)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-13 04:33:38 -07:00
Miss Islington (bot)
6829b1256a
[3.11] Fixes duplicated word (GH-102623) (#102624)
Fixes duplicated word (GH-102623)

In line 1627, the end of the sentence reads "only that that it may be." but it should read "only that it may be" (or alternatively "only that that may be").

(cherry picked from commit e6210621be)

Co-authored-by: Guido van Rossum <guido@python.org>
Co-authored-by: Hugo Gabriel Eyherabide <hugogabriel.eyherabide@gmail.com>
2023-03-12 10:00:04 -07:00
Miss Islington (bot)
495cd2de77
gh-86509: Add link to Lib/_threading_local.py in threading docs (GH-101824)
(cherry picked from commit 53dceb53ad)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-03-10 04:30:24 -08:00
Miss Islington (bot)
ffb41eaaf4
gh-101100: Fix sphinx warnings in zipapp and zipfile modules (GH-102526)
(cherry picked from commit 1f557f94c2)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-03-08 00:30:44 -08:00
Miss Islington (bot)
8bf8e3d9a0
Fix style in argparse.rst (GH-101733)
(cherry picked from commit 061325e0d2)

Co-authored-by: Marcin Wieczorek <marcin@marcin.co>
2023-03-07 23:33:52 -08:00
Miss Islington (bot)
df3ed54e34
[3.11] gh-95913: Edit Faster CPython section in 3.11 WhatsNew (GH-98429) (GH-102490)
gh-95913: Edit Faster CPython section in 3.11 WhatsNew (GH-98429)
(cherry picked from commit 80b19a30c0)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-07 11:08:14 +08:00
Miss Islington (bot)
280b975c3f
Add gettext support to tools/extensions/c_annotations.py (GH-101989)
(cherry picked from commit d959bcd4a0)

Co-authored-by: Rémi Lapeyre <remi.lapeyre@lenstra.fr>
2023-03-06 13:53:47 -08:00
Miss Islington (bot)
caff048cb3
[3.11] Move around example in to_bytes() to avoid confusion (GH-101595) (#102434)
Move around example in to_bytes() to avoid confusion (GH-101595)

Moves an example to be closer to the sentence that refers to it.
(cherry picked from commit 5da379ca7d)

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2023-03-05 09:42:36 +00:00
Ilya Kulakov
cda1d52ab8
[3.11] Clarify re docs for byte pattern group names (GH-99308) (#101001)
Fix wording of the deprecation notice in re for 3.11
2023-03-04 13:36:42 -08:00
Miss Islington (bot)
00791f23b7
gh-102383: [docs] Arguments of PyObject_CopyData are PyObject * (GH-102390)
(cherry picked from commit 7b9132057d)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-03-03 09:27:20 -08:00
Miss Islington (bot)
32a738e5b3
gh-101754: Document that Windows converts keys in os.environ to uppercase (GH-101840)
(cherry picked from commit 4e7c0cbf59)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-03-03 03:00:06 -08:00
Alex Waygood
3b1201daf6
[3.11] Fix typos in documentation and comments (GH-102374) (#102376)
[3.11] Fix typos in documentation and comments (GH-102374)

Found some duplicate `to`s in the documentation and some code comments and fixed them.

[Misc/NEWS.d/3.12.0a1.rst](ed55c69ebd/Misc/NEWS.d/3.12.0a1.rst) also contains two duplicate `to`s, but I wasn't sure if it's ok to touch that file.  Looks auto generated.  I'm happy to amend the PR if requested. :)

Automerge-Triggered-By: GH:AlexWaygood

Co-authored-by: Michael K <michael-k@users.noreply.github.com>
2023-03-02 16:00:06 +00:00
Hugo van Kemenade
9a5f2e8562
[3.11] gh-90744: Fix erroneous doc links in the sys module (GH-101319) (#102321)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Brad Wolfe <brad.wolfe@gmail.com>
Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
Fix erroneous doc links in the sys module (#101319)
2023-03-02 07:43:44 +02:00
Miss Islington (bot)
3effccee48
[3.11] gh-102088 Optimize iter_index itertools recipe (GH-102360) (GH-102363) 2023-03-01 21:52:37 -06:00
Inada Naoki
90ec292ab8
Doc: Fix minor error in ePub (GH-100614)
Fix issue reported https://mail.python.org/archives/list/docs@python.org/message/KE7OIAO53P4XRC4ZOWPDHA63ZQJCHEC3/
(cherry picked from commit 7d1d663418)
2023-03-01 10:19:16 +09:00
Miss Islington (bot)
1ef6e45f96
gh-102296 Document that inspect.Parameter kinds support ordering (GH-102297)
(cherry picked from commit 0db6f44259)

Co-authored-by: Gouvernathor <44340603+Gouvernathor@users.noreply.github.com>
Automerge-Triggered-By: GH:AlexWaygood
2023-02-27 07:21:27 -08:00
Miss Islington (bot)
bd4a709038
gh-101100: Fix sphinx warnings in types module (GH-102274)
(cherry picked from commit 101a12c576)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-02-26 23:33:05 -08:00
Miss Islington (bot)
2c4fc87ac1
[3.11] [doc] Improve grammar/fix missing word (GH-102060) (GH-102277)
[doc] Improve grammar/fix missing word (GH-102060)
(cherry picked from commit 6daf42b28e)

Co-authored-by: VMan <vayidm@users.noreply.github.com>
2023-02-26 18:58:55 +05:30
Miss Islington (bot)
626f471d88
[3.11] gh-85417: Clarify behaviour on branch cuts in cmath module (GH-102046) (#102276)
gh-85417: Clarify behaviour on branch cuts in cmath module (GH-102046)

This PR updates the cmath module documentation to reflect the reality that Python is almost always (and as far as I can tell, that "almost" can be omitted) running on a machine whose C double supports signed zeros.

* Removes misleading references to functions being continuous from above / below / the left / the right at branch cuts
* Expands the note on branch cuts at the top of the module documentation to explain the double-sided sign-of-zero-based behaviour
(cherry picked from commit b513c46d99)

Co-authored-by: Mark Dickinson <dickinsm@gmail.com>
2023-02-26 11:55:25 +00:00
Miss Islington (bot)
7a0dc8a802
gh-102259: Fix re doc issue regarding right square brackets (GH-102264)
(cherry picked from commit bcadcde712)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-02-25 18:32:42 -08:00
Shantanu
735ff5ae27
[3.11] GH-99818: improve the documentation for zipfile.Path and Traversable (GH-101589) (#102266)
Automerge-Triggered-By: GH:FFY00
(cherry picked from commit 84181c1404)

Co-authored-by: Filipe Laíns <lains@riseup.net>
2023-02-25 23:42:30 +00:00
Miss Islington (bot)
c2f42f1778
gh-101100: Fix sphinx warnings in typing module docs (GH-102260)
(cherry picked from commit a498de4c0e)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-02-25 13:55:49 -08:00
Miss Islington (bot)
5775863e9d
asyncio docs: Fix dangling hyphen (GH-102227)
Currently this gets rendered with a dangling hyphen.
(cherry picked from commit 207e1c5cae)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-02-25 05:29:35 -08:00
Miss Islington (bot)
a109ce00de
gh-101100: Fix Sphinx warnings in decimal module (GH-102125)
(cherry picked from commit b7c1126447)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-02-25 01:58:52 -08:00
Miss Islington (bot)
3b4f8fc83d
gh-102105 Fix wording in filterfalse/quantify/filter (GH-102189)
(cherry picked from commit 81bf10e4f2)

Co-authored-by: Stefan Pochmann <609905+pochmann@users.noreply.github.com>
2023-02-24 08:21:40 -08:00
Miss Islington (bot)
61e0bbdb0c
Fix typo in Py_GetPythonHome signature (GH-102168)
(cherry picked from commit 9bba8035bd)

Co-authored-by: Tanner Firl <105078804+TannerFirl@users.noreply.github.com>
2023-02-23 05:38:08 -08:00
Miss Islington (bot)
42d0ca92ed
[3.11] gh-100226: Clarify StreamReader.read behavior (GH-101807) (#102001)
gh-100226: Clarify StreamReader.read behavior (GH-101807)
(cherry picked from commit 77d95c8373)

Co-authored-by: Jan Gosmann <jan@hyper-world.de>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-02-23 19:05:59 +05:30
Miss Islington (bot)
bf0a8362cd
Fix syntax error in struct doc example (GH-102160)
Missing closing ) reported on Discuss by Chukwudi Nwachukwu.
(cherry picked from commit 8f647477f0)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-02-22 16:02:31 -08:00
Miss Islington (bot)
8b5498e367
GH-101777: queue.rst: use 2 spaces after a period to be consistent. (GH-102143)
(cherry picked from commit 96bf24380e)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-02-22 13:39:05 -08:00
Miss Islington (bot)
528e91c067
[3.11] gh-102135: Update turtle docs to rename wikipedia demo to rosette (GH-102137) (GH-102138)
(cherry picked from commit 8d46c7ed5e)

Co-authored-by: somebody <98094921+UndoneStudios@users.noreply.github.com>

Automerge-Triggered-By: GH:hugovk
2023-02-22 02:25:17 -08:00
Miss Islington (bot)
78eee76185
gh-102011: use sys.exception() instead of sys.exc_info() in docs where possible (GH-102012)
(cherry picked from commit 4d3bc89a3f)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2023-02-21 03:06:20 -08:00
Miss Islington (bot)
a94f3ad10b
gh-100556: Improve clarity of or docs (GH-100589)
(cherry picked from commit b40dd71241)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-02-21 02:45:49 -08:00
Miss Islington (bot)
f94ffcf618
gh-101777: Make PriorityQueue docs slightly clearer (GH-102026)
Adjust wording slightly, and use min(entries) instead of
sorted(list(entries))[0] as an example.
(cherry picked from commit 350ba7c07f)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-02-21 02:32:58 -08:00
Miss Islington (bot)
4969903f7e
gh-99735: Use required=True in argparse subparsers example (GH-100927)
(cherry picked from commit 6aab56f3c2)

Co-authored-by: Patricio Paez <nospam@pp.com.mx>
2023-02-19 11:11:40 -08:00
Miss Islington (bot)
62db23c944
Fix incorrectly documented attribute in csv docs (GH-101250)
(cherry picked from commit 36b670908b)

Co-authored-by: Reza Rastak <rezarastak@users.noreply.github.com>
2023-02-18 17:04:01 -08:00
Brian Skinn
5220c2df9e
[3.11] gh-85747: Active voice & suggested edits, 'running/stopping loop' & 'callbacks' subsections of asyncio-eventloop.rst (GH-100270) (#102006)
Note: the `timeout` parameter was not added until 3.12.

(cherry picked from commit c4de6b1d52)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>.
Co-authored-by: Brian Skinn <brian.skinn@gmail.com>
2023-02-18 15:57:06 -08:00
Miss Islington (bot)
b7a49eb5ff
gh-101739: [Enum] update docs - default boundary for Flag is CONFORM (GH-101746)
(cherry picked from commit 7f1c721756)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-02-17 13:44:45 -08:00
Miss Islington (bot)
be69ac3c96
gh-101992: update plistlib examples to be runnable (GH-101994)
* gh-101992: update plistlib examples to be runnable

* Update Doc/library/plistlib.rst

---------

(cherry picked from commit a1723caabf)

Co-authored-by: Dustin Rodrigues <dust.rod@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-02-17 11:39:14 -08:00
Miss Islington (bot)
559d0e8073
gh-101973: Fix parameter reference for PyModule_FromDefAndSpec (GH-101976)
(cherry picked from commit a3bb7fbe7e)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2023-02-17 00:50:46 -08:00
Miss Islington (bot)
aedf38391a
gh-93573: Replace wrong example domains in configparser doc (GH-93574)
* Replace bitbucket.org domain by forge.example
* Update example to python.org
* Use explicitly invalid domain

topsecret.server.com domain is not controled by PSF. It's replaced by invalid topsecret.server.example domain. It follows RFC 2606, which advise .example as TLD for documentation.
(cherry picked from commit 924a3bfa28)

Co-authored-by: sblondon <stephane.blondon@gmail.com>
2023-02-16 07:25:31 -08:00
Miss Islington (bot)
4aeae28671
GH-101898: Fix missing term references for hashable definition (GH-101899)
Fix missing term references for hashable definition
(cherry picked from commit 3690688149)

Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
2023-02-14 02:45:42 -08:00
Miss Islington (bot)
01b21c320b
Correct trivial grammar in reset_mock docs (GH-101861)
(cherry picked from commit a1f08f5f19)

Co-authored-by: Steve Kowalik <steven@wedontsleep.org>
2023-02-13 01:20:18 -08:00
Miss Islington (bot)
1b736838e6
gh-101845: pyspecific: Fix i18n for availability directive (GH-101846)
pyspecific: Fix i18n for availability directive

If the directive has content, the previous code would nest paragraph
nodes from that content inside a general paragraph node, which confuses
Sphinx and leads it to drop the content when translating. Instead, use a
container node for the body.

Also use set_source_info so that any warnings have location info.
(cherry picked from commit 6ef6915d35)

Co-authored-by: Jean Abou-Samra <jean@abou-samra.fr>
2023-02-12 09:28:20 -08:00
Miss Islington (bot)
91fb7c36a3
[3.11] gh-101390: Fix docs for imporlib.util.LazyLoader.factory to properly call it a class method (GH-101391) (#GH-101813)
gh-101390: Fix docs for `imporlib.util.LazyLoader.factory` to properly call it a class method (GH-101391)
(cherry picked from commit 17143e2c30)

Co-authored-by: busywhitespace <busywhitespace@tuta.io>
2023-02-10 16:24:28 -08:00