Commit graph

25090 commits

Author SHA1 Message Date
Miss Islington (bot)
8e386deee9
gh-99953: Purge mention of numeric param style from sqlite3 docs (GH-100630)
The PEP-249 numeric style has never been supported by sqlite3.
(cherry picked from commit b7a68ab824)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2023-01-01 14:35:46 -08:00
Miss Islington (bot)
fd108e5439
gh-100201: Document behavior with a bare yield statement (GH-100416)
(cherry picked from commit 1aab269d4a)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-01-01 07:42:31 -08:00
Miss Islington (bot)
e3b303a020
gh-96773 Fix documentation of socket backlog (GH-96778)
(cherry picked from commit 1d1480fefc)

Co-authored-by: Mehrdad Moradizadeh <mhrddmoradii@gmail.com>
2023-01-01 07:16:25 -08:00
Miss Islington (bot)
f7ad4ffa56
gh-100633 Tutorial: Fix dataclasses import (GH-100638)
import dataclass not dataclasses from dataclasses
(cherry picked from commit 98308dbeb1)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2022-12-31 04:28:36 -08:00
Miss Islington (bot)
504aa92b70
GH-85979: Clarify specification of object.__await__ (GH-22320)
(cherry picked from commit f59c7f8edd)

Co-authored-by: Paolo Lammens <lammenspaolo@gmail.com>
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-12-30 22:31:41 -08:00
Miss Islington (bot)
3ab7b61b41
gh-100616: Document 'attr' parameter for window.vline() in curses module (GH-24961)
(cherry picked from commit f4fcfdf8c5)

Co-authored-by: mathieui <mathieui@users.noreply.github.com>
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-12-30 09:05:40 -08:00
Miss Islington (bot)
2b1cc33db0
[3.10] gh-100583: Improve the pydoc documentation (GH-100590) (#100607)
gh-100583: Improve the `pydoc` documentation  (GH-100590)
(cherry picked from commit 7223d50b97)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
2022-12-29 21:45:13 +05:30
Miss Islington (bot)
4217fafeac
GH-100101: Clarify documentation of zip's strict option (GH-100103)
(cherry picked from commit cf1c098180)

Co-authored-by: JustAnotherArchivist <JustAnotherArchivist@users.noreply.github.com>
2022-12-28 13:32:44 -08:00
Miss Islington (bot)
97a3e18c88
gh-55688: Add note about ending backslashes for raw strings (GH-94768)
(cherry picked from commit b95b1b3b25)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: hauntsaninja <hauntsaninja@gmail.com>
2022-12-27 21:39:53 -08:00
Jelle Zijlstra
1ffc67265f
[3.10] gh-99535: Add test for inheritance of annotations and update documentation (GH-99990) (#100509)
(cherry picked from commit f5b7b19bf1)

Co-authored-by: MonadChains <monadchains@gmail.com>
2022-12-26 20:44:53 -08:00
Shantanu
a167365d85
[3.10] gh-92446: Improve argparse choices docs (GH-94627) (#100529)
Based on the definition of the collections.abc classes, it is more accurate to use "sequence" instead of "container" when describing argparse choices.

(cherry picked from commit ad3c99e521)

Co-authored-by: Guy Yagev <yourlefthandman8@gmail.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-26 01:10:48 -06:00
Miss Islington (bot)
ad8d2ef54f
gh-100472: Fix docs claim that compileall parameters could be bytes (GH-100473)
(cherry picked from commit 046cbc2080)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-24 12:29:41 -08:00
Miss Islington (bot)
0dea92409e
gh-100428: Make float documentation more accurate (GH-100437)
Previously, the grammar did not accept `float("10")`.
Also implement mdickinson's suggestion of removing the indirection.
(cherry picked from commit 2e1a9ce989)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-24 12:15:46 -08:00
Miss Islington (bot)
3ea6f7fee8
gh-99908: Tutorial: Modernize the 'data-record class' example (GH-100499)
(cherry picked from commit 00afa5066b)

Co-authored-by: JosephSBoyle <48555120+JosephSBoyle@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-12-24 07:32:29 -08:00
Miss Islington (bot)
ecfe468a6e
gh-77771: Add enterabs example in sched (GH-92716)
(cherry picked from commit 0f6420640c)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-23 21:30:06 -08:00
Gregory P. Smith
88fe8d701a
[3.10] Correct CVE-2020-10735 documentation (GH-100306). (#100477)
(cherry picked from commit 1cf3d78c92)

Co-authored-by: Jeremy Paige <ucodery@gmail.com>
2022-12-23 18:08:27 -08:00
Miss Islington (bot)
bd472198c6
gh-98712: Clarify "readonly bytes-like object" semantics in C arg-parsing docs (GH-98710)
(cherry picked from commit 49f6ff719c)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2022-12-23 07:09:34 -08:00
Miss Islington (bot)
86cdfaa885
gh-48496: Added example and link to faq for UnboundLocalError in reference (GH-93068)
(cherry picked from commit f3db68e6e6)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-12-22 15:30:09 -08:00
Miss Islington (bot)
561e15b857
gh-91081: Add note on WeakKeyDictionary behavior when deleting a replaced entry (GH-91499)
(cherry picked from commit c615286e85)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Pieter Eendebak <P.T.eendebak@tudelft.nl>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-12-20 19:34:24 -08:00
Miss Islington (bot)
b3d39c7599
gh-99991: improve docs on str.encode and bytes.decode (GH-100198)
(cherry picked from commit a2bb3b7f9d)

Co-authored-by: Bisola Olasehinde <horlasehinde@gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-12-20 18:11:20 -08:00
Miss Islington (bot)
a757c1b7d3
Clarify that every thread has its own default context in contextvars (GH-99246)
(cherry picked from commit cb60b6131b)

Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
2022-12-20 03:45:48 -08:00
Miss Islington (bot)
b81d1c3be3
gh-69929: re docs: Add more specific definition of \w (GH-92015)
(cherry picked from commit 36a0b1d0dd)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-12-19 19:14:48 -08:00
Miss Islington (bot)
e38a525c20
gh-97909: Fix markup for PyMethodDef members (GH-100089)
(cherry picked from commit 8edcb30c3f)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
2022-12-16 23:19:54 -08:00
Miss Islington (bot)
697a07a854
Document that zipfile's pwd parameter is a bytes object (GH-100209)
(cherry picked from commit 5ee7eb9deb)

Co-authored-by: JustAnotherArchivist <JustAnotherArchivist@users.noreply.github.com>
2022-12-16 22:53:20 -08:00
Miss Islington (bot)
958be792a7
gh-99830: asyncio: Document returns of remove_{reader,writer} (GH-100302)
(cherry picked from commit 5234e1cbea)

Co-authored-by: Ben Darnell <ben@bendarnell.com>
2022-12-16 11:15:12 -08:00
Miss Islington (bot)
0f61020255
"Compound statement" docs: Fix with-statement step indexing (GH-100286)
Back in commit 226e6e7d43
an item was added to the list, renumbering all the rest of the
items, but the forward-reference wasn't updated to match.
(cherry picked from commit f23236a92d)

Co-authored-by: Frank Dana <ferdnyc@gmail.com>
2022-12-16 11:02:41 -08:00
Miss Islington (bot)
f5f68ff192
GH-100206: use versionadded for the addition of sysconfig.get_default_scheme (GH-100207)
(cherry picked from commit d3ea82aaf9)

Co-authored-by: Filipe Laíns <lains@riseup.net>
2022-12-13 03:03:22 -08:00
Miss Islington (bot)
24ed439462
Fix: typo (Indention) (GH-99904)
Example needed to be indented. Was trying to call a context manger `pr` (from ` with cProfile.Profile() as pr:`) wot perform ` pr.print_stats()` once it had already exited.
(cherry picked from commit 8711b59f7a)

Co-authored-by: jarrodcolburn <jcourtlandcolburn@gmail.com>
Automerge-Triggered-By: GH:AlexWaygood
2022-12-12 04:40:09 -08:00
Miss Islington (bot)
eece1bdca7
gh-70393: Clarify mention of "middle" scope (GH-98839)
(cherry picked from commit 70be5e42f6)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-11 20:26:30 -08:00
Miss Islington (bot)
e6b0bd5948
gh-99728: correct typo in datetime format codes documentation (GH-99750)
(cherry picked from commit d5f8a2b6ad)

Co-authored-by: Brad Wolfe <brad.wolfe@gmail.com>
2022-12-10 02:28:51 -08:00
Miss Islington (bot)
92dd53bf94
gh-100049: fix repr for mappingproxy in dictionary view example doc (GH-100052)
(cherry picked from commit 7c0fb71fbf)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
2022-12-10 01:24:46 -08:00
Miss Islington (bot)
8ef6045187
gh-96250: Improve sqlite3 injection attack example (GH-99270)
(cherry picked from commit 41d4ac9da3)

Co-authored-by: Jia Junjie <62194633+jiajunjie@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-12-08 12:45:32 -08:00
Łukasz Langa
300d812fd1
[3.10] gh-93453: Only emit deprecation warning in asyncio.get_event_loop when a new event loop is created (#100059)
It no longer emits a deprecation warning if the current event loop was set.

(cherry picked from commit 3fae04b10e)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-12-06 18:40:30 +01:00
Miss Islington (bot)
b7ae1d2285
[3.10] gh-100001: Remove doc typo, add versionadded (GH-100042) (#100044)
(cherry picked from commit bed15f87ea)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2022-12-06 11:34:49 +01:00
Miss Islington (bot)
ec8c06bc28
gh-100001: Omit control characters in http.server stderr logs. (GH-100002)
Replace control characters in http.server.BaseHTTPRequestHandler.log_message with an escaped \xHH sequence to avoid causing problems for the terminal the output is printed to.
(cherry picked from commit d8ab0a4dfa)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2022-12-05 13:16:14 -08:00
Eric V. Smith
e5075986a7
[3.10] dataclasses.rst: Prevent horizontal scrolling (gh-100025). (gh-100029)
(cherry picked from commit 51ee0a29e9)

Co-authored-by: Ram Rachum <ram@rachum.com>

Co-authored-by: Ram Rachum <ram@rachum.com>
2022-12-05 14:19:09 -05:00
Miss Islington (bot)
e2209cb6ec
gh-85747: "Preface" section of asyncio-eventloop.rst: Switch to active voice and suggest other edits (GH-99784)
(cherry picked from commit bf26bdf6ac)

Co-authored-by: Brian Skinn <brian.skinn@gmail.com>
2022-12-03 16:59:47 -08:00
Miss Islington (bot)
80f4624f8e
[3.10] GH-98906 ``re` module: `search() vs. match()` section should mention `fullmatch()`` (GH-98916) (GH-99913)
GH-98906 ```re``` module: ```search() vs. match()``` section should mention ```fullmatch()``` (GH-98916)

Mention fullmatch along with search and match.
(cherry picked from commit e0f91deb59)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
2022-11-30 18:14:47 -05:00
Miss Islington (bot)
3baaa97d6c
Docs: improve accuracy of socketserver reference (GH-24767)
(cherry picked from commit 052bc128ac)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2022-11-29 12:41:38 -08:00
Miss Islington (bot)
9057296317
whatsnew-3.10: Mention PEP 647 in the Release highlights section. (GH-99853)
Mention PEP 647 in the Release highlights section.

Also re-ordered the list so it matches the order in the details sections below.
(cherry picked from commit d74a58872c)

Co-authored-by: Yilei "Dolee" Yang <yileiyang@google.com>
2022-11-29 12:39:16 -08:00
Steve Dower
ca3c48072b
gh-90717: Update the documentation for the altchars paremeter in base64 library (GH-94187)
Co-authored-by: Sam Ezeh <sam.z.ezeh@gmail.com>
2022-11-29 16:43:36 +00:00
Miss Islington (bot)
b1c148c1be
gh-99249: Clarify "read-only" slots tp_bases & tp_mro (GH-99342)
These slots are marked "should be treated as read-only" in the
table at the start of the document.  That doesn't say anything about
setting them in the static struct.

`tp_bases` docs did say that it should be ``NULL`` (TIL!). If you
ignore that, seemingly nothing bad happens. However, some slots
may not be inherited, depending on which sub-slot structs are present.
(FWIW, NumPy sets tp_bases and is affected by the quirk -- though to
be fair, its DUAL_INHERIT code probably predates tp_bases docs, and
also the result happens to be benign.)

This patch makes things explicit.
It also makes the summary table legend easier to scan.

(cherry picked from commit 219696abb2)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-11-28 03:26:05 -08:00
Miss Islington (bot)
ab87bcd91f
Docs: both sqlite3 "point examples" now adapt to str (GH-99823)
(cherry picked from commit 276643e207)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-11-27 13:16:34 -08:00
Miss Islington (bot)
72d173599d
doc: Remove backslashes in doctest grammar docs (GH-29346)
(cherry picked from commit 22860dbbc8)

Co-authored-by: George Zhang <geetransit@gmail.com>
2022-11-26 22:47:07 -08:00
Miss Islington (bot)
43234396ee
bpo-43327: Fix the docs for PyImport_ImportFrozenModuleObject() (GH-24659)
The docs stated that PyImport_ImportFrozenModuleObject() returns a
new reference, but it actually returns an int.

(cherry picked from commit 62a5dc13e9)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-11-26 22:35:36 -08:00
Jason R. Coombs
3d82b7ed8d
[3.10] gh-99795: Fix typo in importlib.resources.abc (GH-99796) (GH-99800)
Changing TraversableReader to TraversableResources at one place of the documentation.

See GH-99795 for more details..
(cherry picked from commit 5f8898216e)

Co-authored-by: busywhitespace <busywhitespace@tuta.io>

Co-authored-by: busywhitespace <busywhitespace@tuta.io>
2022-11-26 13:22:13 -05:00
Miss Islington (bot)
1fc2e2aa92
[3.10] gh-99502: mention bytes-like objects as input in secrets.compare_digest (GH-99512) (#99790)
gh-99502: mention bytes-like objects as input in `secrets.compare_digest` (GH-99512)

Now it is in sync with https://docs.python.org/3/library/hmac.htmlGH-hmac.compare_digest
It is the same function, just re-exported. So, I guess they should mention the same input types.
(cherry picked from commit 47d673d81f)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2022-11-26 15:19:08 +05:30
Miss Islington (bot)
fae745ed14
Fix typo in __match_args__ doc (GH-99785)
A opy of GH-98549, whose author (@icecream17) uses a school computer that blocks the CLA site. I did not mention this in commit comment above so CLA bot does not pick up the name and request the CLA again.
(cherry picked from commit a86d854522)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-11-25 16:11:48 -08:00
Miss Islington (bot)
aabe83124a
gh-96168: Add sqlite3 row factory how-to (GH-99507)
(cherry picked from commit 8749121b07)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-11-25 05:21:00 -08:00
Miss Islington (bot)
59241fe2a2
Fix rendering of audioop license in Doc/license.rst (GH-99752)
Also some cosmetic blank line additions for consistency with the
formatting of the rest of the file.
(cherry picked from commit b5b3904f05)

Co-authored-by: Zachary Ware <zach@python.org>
2022-11-24 08:27:11 -08:00