Commit graph

11980 commits

Author SHA1 Message Date
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)
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)
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)
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
Hugo van Kemenade
c485f0e39e
[3.11] Docs: Fix getstatus() -> getcode() typos (GH-101296) (#101805) 2023-02-11 00:26:41 +02:00
Miss Islington (bot)
18313ecb09
Docs: use parameter list for sqlite3.Cursor.execute* (GH-101782)
(cherry picked from commit 2037ebf81b)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-02-10 10:01:38 -08:00
Miss Islington (bot)
4a9dff0e5a
gh-101283: Version was just released, so should be changed in 3.11.3 (GH-101719)
(cherry picked from commit 0e0c5d8baa)

Co-authored-by: Steve Dower <steve.dower@python.org>
2023-02-08 16:11:36 -08:00
Miss Islington (bot)
51b079a2d6
Update Lib/subprocess.py 2023-02-08 15:44:06 -08:00
Miss Islington (bot)
7240ba7f94
[3.11] gh-47937: Note that Popen attributes are read-only (GH-93070) (#101684)
* Note that Popen attributes aren't meant to be set by users by rewording the text about the attributes.
* Also update some universal_newlines references to mention the modern text parameter name while in the area.

(cherry picked from commit 027adf42cd)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Gregory P. Smith <greg@krypto.org>
2023-02-08 11:03:56 +01:00
Oleg Iarygin
fa90671480
[3.11] gh-97725: Fix documentation for the default file of asyncio.Task.print_stack (#101652) (#101653)
(cherry picked from commit f87f6e2396)
2023-02-08 11:02:37 +01:00
Miss Islington (bot)
7cbcfbe2ff
GH-56426: Add cross-reference to the documentation for faulthandler, traceback, and pdb. (GH-101157)
(cherry picked from commit cef9de62b8)

Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-02-03 19:56:57 -08:00
Miss Islington (bot)
2366c1a4fe
gh-100920: Update documentation for asyncio.StreamWriter.wait_closed (GH-101514)
(cherry picked from commit 5c39daf50b)

Co-authored-by: Viet Than <thanhoangviet@gmail.com>
2023-02-02 23:26:37 -08:00
Miss Islington (bot)
bfac5d9850
gh-100925: Move array methods under class in array doc (GH-101485)
* Move array methods under class in array doc

* Fix a few internal references related to the touched lines
(cherry picked from commit 1b6045668d)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-02-02 16:12:09 -08:00
Miss Islington (bot)
08f5c77359
docs: Fix enum reassign str documentation (GH-101507)
(cherry picked from commit 24cbc7a2a0)

Co-authored-by: Peter Gessler <gesslerpd@users.noreply.github.com>
2023-02-02 12:40:30 -08:00
Miss Islington (bot)
c2c970fc26
Docs: improve accuracy of sqlite3 check_same_thread parameter (GH-101351)
(cherry picked from commit ee21110086)

Co-authored-by: Marcos Pereira <3464445+marcospgp@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-02-01 16:00:27 -08:00
Miss Islington (bot)
89442e18e1
gh-101498 : Fix asyncio.Timeout example in docs (GH-101499)
Doc/library/asyncio-task.rstGH-timeout
(cherry picked from commit 95fb0e0258)

Co-authored-by: Raj <51259329+workingpayload@users.noreply.github.com>
2023-02-01 10:19:11 -08:00
Irit Katriel
c796d34b2a
[3.11] gh-101454: fix documentation for END_ASYNC_FOR (#101455) (#101493)
gh-101454: fix documentation for END_ASYNC_FOR (#101455)

(cherry picked from commit 62251c3da0)
2023-02-01 14:30:48 +00:00
Miss Islington (bot)
85cc5d0e5d
gh-98657: [docs] array.typecodes is a module-level attribute (GH-98729)
* gh-98657: [docs] `array.typecodes` is a module-level attribute

* Update array.rst
(cherry picked from commit c144e57b31)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-01-31 21:48:19 -08:00
Miss Islington (bot)
a79dd88973
gh-77607: Improve accuracy of os.path.join docs (GH-101406)
This is a follow-up to GH-100811.

One of the changes in that PR isn't accurate in that
`os.path.join('', '')` will not end in a separator.

This reverts that change to the previous wording that used "only", but
explicitly calls out the case where the last part ends in a separator,
which is what caused confusin in GH-77607 and motivated the change
in GH-100811.
(cherry picked from commit 909a674693)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-01-30 21:46:48 -08:00
Miss Islington (bot)
6a94f4c973
Fixes typo in asyncio.TaskGroup context manager code example (GH-101449)
(cherry picked from commit ef09bf63d2)

Co-authored-by: Ben <22038077+bcla22@users.noreply.github.com>
2023-01-30 21:46:35 -08:00
Miss Islington (bot)
6ec9f2d5b8
gh-101422: (docs) TarFile default errorlevel argument is 1, not 0 (GH-101424)
(cherry picked from commit ea232716d3)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-01-30 10:10:26 -08:00
Miss Islington (bot)
3bcb630e07
gh-98240: Updated Path.rename docs, when it is atomic (GH-98245)
(cherry picked from commit 0023f51deb)

Co-authored-by: Mateusz <mateka@users.noreply.github.com>
2023-01-29 17:52:29 -08:00
Miss Islington (bot)
88a1e6db0f
[3.11] [doc] Add a section on logging handler configuration order. (GH-101380) (GH-101382)
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2023-01-27 19:12:18 +00:00
Miss Islington (bot)
1016909a6d
[3.11] [doc] Add some notices to logging configuration documentation. (GH-101373) (GH-101376)
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2023-01-27 17:45:59 +00:00
Miss Islington (bot)
4cf4169350
Added asyncio REPL example to docs. (GH-101243)
(cherry picked from commit 5d868efde9)

Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es>
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2023-01-23 03:39:01 -08:00
Miss Islington (bot)
69d12d868e
[3.11] GH-101097: Switch from standard interval notation to greater or less than signs for random.random()'s documentation (GH-101119) (GH-101246)
(cherry picked from commit 8bcd4a6ec7)

Co-authored-by: Andrew Hong <andrewhong@myyahoo.com>

Automerge-Triggered-By: GH:rhettinger
2023-01-22 13:45:55 -08:00
Miss Islington (bot)
db0eeb381e
[3.11] gh-86610: Use attribute directive in docs for pathlib.PurePath (GH-101114) (#101205)
(cherry picked from commit 01093b8203)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
2023-01-20 23:28:21 +01:00
Miss Islington (bot)
efc89f3454
[3.11] GH-101111: Disambigaute origin of const for store_const and append_const (GH-101121) (#101203)
(cherry picked from commit 9a155138c5)

While the documentation for `optparse` mentioned that both `store_const` and
`append_const` store a constant value, it was not clear where this value was
coming from.

A link to `Option.const` makes this explicit.

Co-authored-by: Jürgen Gmach <juergen.gmach@googlemail.com>
2023-01-20 23:22:04 +01:00
Miss Islington (bot)
1798df2b40
[3.11] Fix minor typos in SSL documentation (GH-101158) (#101201)
(cherry picked from commit 73497690b5)

Co-authored-by: Simon Robinson <simon@robinson.ac>
2023-01-20 23:18:25 +01:00
Miss Islington (bot)
0dc35e4bbb
gh-91485: Avoid unnecessary use of non-Python syntax in io docs (GH-101177)
(cherry picked from commit 783d1bc51b)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-01-20 14:12:26 -08:00
Miss Islington (bot)
e039d53dae
[3.11] gh-101100: [Enum] Fix sphinx warnings in docs (GH-101122) (#101173)
(cherry picked from commit 9e025d305f)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-01-20 23:07:23 +01:00
Gregory P. Smith
efe3a389ca
[3.11] gh-101144: Allow zipfile.Path .open & .read_text encoding to be positional (#101179)
The zipfile.Path open() and read_text() encoding parameter can be supplied as a positional argument without causing a TypeError again. 3.10.0b1 included a regression that made it keyword only.

Documentation update included as users writing code to be compatible with a wide range of versions will need to consider this for some time..

(cherry picked from commit 5927013e47)

Co-authored-by: Gregory P. Smith <greg@krypto.org> [Google]
2023-01-20 00:06:18 -08:00
Miss Islington (bot)
1998ea69c7
gh-101041: Fix a misspelled name of utctimetuple in a doc warning (GH-101042)
(cherry picked from commit 8e9d08b062)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2023-01-19 21:06:47 -08:00