Commit graph

11719 commits

Author SHA1 Message Date
Miss Islington (bot)
c2f21af42a
gh-65496: Correct wording on csv's skipinitialspace argument (GH-96170)
(cherry picked from commit 676d8ef380)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-07 16:45:53 -07:00
Miss Islington (bot)
17c9ce112f
gh-61105: Add default param, note on using cookiejar subclass (GH-95427)
(cherry picked from commit 5eaf4d6101)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-07 16:05:52 -07:00
Miss Islington (bot)
40d5e89d3b
[3.11] gh-91708: Revert params note in urllib.parse.urlparse table (GH-96699) (#98052)
Revert params note in urllib.parse.urlparse table
(cherry picked from commit eed80458e8)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-07 13:53:15 -07:00
Miss Islington (bot)
3dc8eb41bc
gh-64921: Clarify wording for open()'s newline arg (GH-96171)
(cherry picked from commit 4a74e6ab38)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-07 11:21:01 -07:00
Miss Islington (bot)
245ea1f500
gh-71316: Update dis documentation to include changes to jump arguments (GH-95798)
(cherry picked from commit 6592a62ec2)

Co-authored-by: Christopher Chianelli <cchianel@redhat.com>
2022-10-07 07:10:46 -07:00
Miss Islington (bot)
d7547fc6fb
Misc updates to the itertools recipes and tests (GH-98018)
(cherry picked from commit e500cc0451)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2022-10-07 01:46:31 -07:00
Miss Islington (bot)
d163d5976d
GH-90985: Revert "Deprecate passing a message into cancel()" (GH-97999)
Reason: we were too hasty in deprecating this.
We shouldn't deprecate it before we have a replacement.
(cherry picked from commit 09de8d7aaf)

Co-authored-by: Guido van Rossum <guido@python.org>
2022-10-06 18:50:25 -07:00
Miss Islington (bot)
1144cf64d8
[3.11] gh-95691: Doc BufferedWriter and BufferedReader (GH-95703) (#97947)
gh-95691: Doc BufferedWriter and BufferedReader (GH-95703)
(cherry picked from commit 0d68879104)

Co-authored-by: 180909 <734461790@qq.com>

Co-authored-by: 180909 <734461790@qq.com>
2022-10-05 17:21:55 -07:00
Miss Islington (bot)
0c387bf978
GH-88968: Add notes about socket ownership transfers (GH-97936)
(cherry picked from commit 74ea204634)

Co-authored-by: Guido van Rossum <guido@python.org>
2022-10-05 16:54:21 -07:00
Miss Islington (bot)
19ec4d40a2
[3.11] gh-96197: Fix expression when :func:`sys.breakpointhook is missing (gh-96293) (#96294)
(cherry picked from commit 47d406ffc4)

Co-authored-by: Dong-hee Na <donghee.na@python.org>
2022-10-05 15:03:18 -07:00
Łukasz Langa
83ad76275c
[3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97924)
:c:type:`<C type>` -> :c:expr:`<C type>`

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 0031e62973)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-05 14:11:12 -07:00
Miss Islington (bot)
61183b95ae
docs(typing): add "see PEP 675" to LiteralString (GH-97926)
(cherry picked from commit 2016bc54a2)

Co-authored-by: Simon Legner <Simon.Legner@gmail.com>
2022-10-05 13:16:12 -07:00
Miss Islington (bot)
ef77f2f068
GH-95172 Make the same version versionadded oneline (GH-95172)
* Make the same version versionadded oneline

* Format versionadded for enum.rst

* Format versionadded

A single line versionadded was reading better.

Co-authored-by: Senthil Kumaran <senthil@python.org>
(cherry picked from commit d6062d1170)

Co-authored-by: 180909 <734461790@qq.com>
2022-10-05 11:01:17 -07:00
Miss Islington (bot)
d5852a090f
[3.11] gh-93738: Documentation C syntax (Use c:struct) (GH-97772) (#97869)
Use `c:struct`
(cherry picked from commit a0f5599aac)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-05 08:20:03 -07:00
Miss Islington (bot)
0a2008037f
[3.11] gh-93738: Documentation C syntax (:c:type:PyObject -> :c:expr:PyObject) (GH-97776) (#97889)
:c:type:`PyObject` -> :c:expr:`PyObject`
(cherry picked from commit 0bf6a617ed)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-05 08:18:27 -07:00
Miss Islington (bot)
79b5c1ad3c
gh-97661: Improve accuracy of sqlite3.Cursor.fetchone docs (GH-97662)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 4b83cd0b22)

Co-authored-by: Jia Junjie <62194633+jiajunjie@users.noreply.github.com>
2022-10-05 01:57:30 -07:00
Miss Islington (bot)
0151375829
Add re.VERBOSE flag documentation example (GH-97678)
The current re.VERBOSE documentation example leaves space for ambiguous
interpretation. One may read that spaces within the `(?:` token are
spaces inside the non-capturing group (such as `(?: )`). This patch
removes the ambiguity by including examples after the statement.
(cherry picked from commit 0ceafa7fa4)

Co-authored-by: Athos Ribeiro <athoscribeiro@gmail.com>
2022-10-04 18:29:54 -07:00
Miss Islington (bot)
5fdce5d009
[3.11] gh-88355: Fix backslashes in AF_PIPE (GH-96543) (#97854)
gh-88355: Fix backslashes in AF_PIPE (GH-96543)

Fix backslashes in AF_PIPE (GH-88355)

The correct syntax for AF_PIPE addresses is `\\.\pipe\blahblah`, not `\.\pipe{blahblah}`, but the syntax markup messed up the backslashes.
(cherry picked from commit ff28d8926d)

Co-authored-by: cousteau <cousteaulecommandant@users.noreply.github.com>

Co-authored-by: cousteau <cousteaulecommandant@users.noreply.github.com>
2022-10-04 15:55:34 -07:00
Miss Islington (bot)
d45698269e
[3.11] gh-96448: fix documentation for _thread.lock.acquire (GH-96449) (#97851)
gh-96448: fix documentation for _thread.lock.acquire (GH-96449)

* fix documentation for _thread.lock.acquire

* update formatting of _thread.lock.acquire() doc
(cherry picked from commit 7acb93f0d4)

Co-authored-by: Daniel Giger <danielg3432@gmail.com>

Co-authored-by: Daniel Giger <danielg3432@gmail.com>
2022-10-04 15:21:28 -07:00
Miss Islington (bot)
cad4dca7bf
gh-90301: Doc: Add references to PEP 686 (GH-96816)
Doc: Add references to PEP 686.
(cherry picked from commit 87679a6e60)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2022-10-04 15:14:52 -07:00
Miss Islington (bot)
0dcfe0f47e
GH-82604: fix docs about configuring selector (GH-97755)
(cherry picked from commit 53503ff60e)

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-10-04 09:52:28 -07:00
Miss Islington (bot)
789d5bc80a
Update http.client.rst (GH-24803)
* Update http.client.rst

* Apply suggestions from code review

Co-authored-by: Éric <merwok@netwok.org>

* Update http.client.rst

Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Senthil Kumaran <senthil@python.org>
(cherry picked from commit 0c91a12511)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2022-10-03 16:35:10 -07:00
Miss Islington (bot)
541265fd7c
Minor grammar changes to http.client docs (GH-96221)
Minor grammar changes
(cherry picked from commit d053c47bfd)

Co-authored-by: Rohan Shah <57906961+rshah713@users.noreply.github.com>
2022-10-03 16:30:07 -07:00
Miss Islington (bot)
ca05666fed
multiprocessing docs: Remove extra option ELLIPSIS from section with code (GH-96625)
(cherry picked from commit d78aa4e11a)

Co-authored-by: Ivan Kapeykin <5349983@gmail.com>
2022-10-03 15:48:00 -07:00
Miss Islington (bot)
d07428607a
Document that MozillaCookieJar works for curl's cookie files (GH-91852)
MozillaCookieJar works for curl's cookies
(cherry picked from commit 0ea8b925d0)

Co-authored-by: Boris Verkhovskiy <boris.verk@gmail.com>
2022-10-03 15:46:23 -07:00
Miss Islington (bot)
096e39637b
Fix typo in unittest docs (GH-97742)
(cherry picked from commit e6f9ec5c03)

Co-authored-by: annonm <annonm@gmail.com>
2022-10-03 06:43:31 -07:00
Miss Islington (bot)
b26fb3cdc6
GH-85447: Clarify docs about awaiting future multiple times (GH-97738)
(cherry picked from commit 9151bbefea)

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-10-02 15:27:17 -07:00
Miss Islington (bot)
9189cd6b05
gh-95588: Drop the safety claim from ast.literal_eval docs. (GH-95919)
It was never really safe and this claim conflicts directly with the big warning in the docs about it being able to crash the interpreter.
(cherry picked from commit 8baef8ae36)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2022-10-01 18:21:15 -07:00
Miss Islington (bot)
35a394c556
Fix capitalization of Unix in documentation (GH-96913)
(cherry picked from commit bd7d0e875e)

Co-authored-by: Will Hawkins <8715530+hawkinsw@users.noreply.github.com>
2022-10-01 16:51:34 -07:00
Miss Islington (bot)
3614bbb8eb
gh-90908: Document asyncio.Task.cancelling() and asyncio.Task.uncancel() (GH-95253)
Co-authored-by: Thomas Grainger <tagrain@gmail.com>
(cherry picked from commit f00645d5db)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-10-01 11:10:04 -07:00
Miss Islington (bot)
cdc01eaed9
gh-87597: Document TimeoutExpired.stdout & .stderr types (GH-97685)
This documents the behavior that has always been the case since timeout
support was introduced in Python 3.3.
(cherry picked from commit b05dd79649)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2022-09-30 10:54:12 -07:00
Miss Islington (bot)
27891e0d7b
gh-96397: Document that attributes need not be identifiers (GH-96454)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 9a11ed8e50)

Co-authored-by: Jeff Allen <ja.py@farowl.co.uk>
2022-09-29 16:25:10 -07:00
Miss Islington (bot)
11b66717fe
gh-52597: Add position-only markers for os functions (GH-94735)
(cherry picked from commit c759944f16)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-09-29 06:51:39 -07:00
Miss Islington (bot)
b8bc11e501
fixup policy docs (GH-97618)
(cherry picked from commit 9a404b173e)

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-09-28 10:42:28 -07:00
Miss Islington (bot)
c2ec6da74f
gh-96377: Update asyncio policy doc intro paras to be clear and accurate (GH-97603)
Also fix up some cross-references in the asyncio docs.
(cherry picked from commit cc0f3a10f0)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-09-27 17:33:32 -07:00
Miss Islington (bot)
dfe23ee20f
gh-96959: Update more HTTP links (GH-97536)
Use HTTPS for documents which are available by both HTTP and HTTPS
links, but there is no redirection from HTTP to HTTPS or vice versa.
(cherry picked from commit dd53b79de0)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-09-27 04:16:37 -07:00
Miss Islington (bot)
82932b3ec9
GH-65046: Fix docs about logging in asyncio (GH-97559)
Explain that logging should not use network I/O.
(cherry picked from commit d68c37c0d0)

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-09-26 15:45:58 -07:00
Miss Islington (bot)
4d1de87042
gh-96959: Update HTTP links which are redirected to HTTPS (GH-96961)
(cherry picked from commit db39050396)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-09-25 01:20:45 -07:00
Steve Dower
dc9065f8c2
gh-77171: Document that wave only supports simple PCM files (GH-97510) 2022-09-23 13:55:06 +01:00
Miss Islington (bot)
fc1cbe761b
[3.11] gh-96727: Document restrictions on Handler.emit() with respect to locking. (GH-96948) (GH-96950)
(cherry picked from commit 6ad47b41a6)
2022-09-20 09:52:09 +01:00
Miss Islington (bot)
e0d6cc8316
gh-96917: link to typing.readthedocs.io from typing.rst (GH-96921)
See the discussion at https://github.com/python/cpython/issues/91533
(cherry picked from commit 5b3a2569f4)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-09-19 12:19:18 -07:00
Miss Islington (bot)
8e2bda8227
GH-96851: Add link to FAQ entry for caching method calls. (GH-96902)
(cherry picked from commit bbc24b2bd5)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2022-09-18 15:53:31 -07:00
Miss Islington (bot)
1448e2a42b
Simplify sieve() recipe. Add edge case tests. (GH-96892)
(cherry picked from commit 78359b1d45)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2022-09-17 20:11:29 -07:00
Miss Islington (bot)
e0b02ef27e
Clarify that the expression is regular math notation, not Python. (GH-96903) (GH-96908) 2022-09-17 22:01:12 -05:00
Miss Islington (bot)
92a0e81fe1
gh-95778: Mention sys.set_int_max_str_digits() in error message (GH-96874)
When ValueError is raised if an integer is larger than the limit,
mention sys.set_int_max_str_digits() in the error message.
(cherry picked from commit e841ffc915)

Co-authored-by: Victor Stinner <vstinner@python.org>
2022-09-16 11:33:27 -07:00
Miss Islington (bot)
9ab9e82b86
gh-96810: Clarify for which statements sqlite3 implicitly opens transactions (GH-96832)
(cherry picked from commit 16c33a9676)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-09-15 14:21:08 -07:00
Miss Islington (bot)
b31b1b1248
gh-96702: Order methods before attrs in sqlite3.Connection docs (GH-96703) (#96788)
(cherry picked from commit 49cceeb5c9)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-09-14 21:56:14 +02:00
Miss Islington (bot)
a0685136dc
Itertools sieve() recipe (GH-96813) (GH-96814) 2022-09-13 21:23:30 -05:00
Miss Islington (bot)
12c8a9edfd
gh-95778: Fix sys.set_int_max_str_digits() parameter name (GH-96798)
Discovered in https://github.com/python/typeshed/pull/8733
(cherry picked from commit bf5fd49252)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-09-13 09:44:56 -07:00
Miss Islington (bot)
6726405ec3
gh-96706: [doc] Don't recomment deprecated use of get_event_loop() in examples (GH-96707)
(cherry picked from commit 53a54b781d)

Co-authored-by: zhanpon <pon.zhan@gmail.com>
2022-09-13 08:57:02 -07:00