Commit graph

11717 commits

Author SHA1 Message Date
Miss Islington (bot)
a955cccf7a
Clarify that the expression is regular math notation, not Python. (GH-96903) (GH-96908) 2022-10-22 20:06:11 +01:00
Miss Islington (bot)
122a07c869
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-10-22 20:06:10 +01:00
Miss Islington (bot)
1c345fa012
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-10-22 20:06:09 +01:00
Miss Islington (bot)
2a1e9b01d1
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-10-22 20:06:06 +01:00
Miss Islington (bot)
6464096400
[3.11] gh-96727: Document restrictions on Handler.emit() with respect to locking. (GH-96948) (GH-96950)
(cherry picked from commit 6ad47b41a6)
2022-10-22 20:06:05 +01:00
Steve Dower
00e8a27dee
gh-77171: Document that wave only supports simple PCM files (GH-97510) 2022-10-22 20:06:02 +01:00
Miss Islington (bot)
e65e6de0fb
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-10-22 20:06:00 +01:00
Miss Islington (bot)
50da78af68
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-10-22 20:05:59 +01:00
Miss Islington (bot)
2b0b017683
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-10-22 20:05:58 +01:00
Miss Islington (bot)
f0cbc6c18e
fixup policy docs (GH-97618)
(cherry picked from commit 9a404b173e)

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-10-22 20:05:55 +01:00
Miss Islington (bot)
68b7a6ab99
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-10-22 20:05:54 +01:00
Miss Islington (bot)
f20ad5ef45
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-10-22 20:05:52 +01:00
Miss Islington (bot)
c12c993aa1
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-10-22 20:05:50 +01:00
Miss Islington (bot)
b8afd5ffd3
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-22 20:05:49 +01:00
Miss Islington (bot)
c8bdf339d7
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-22 20:05:45 +01:00
Miss Islington (bot)
ce01c59b25
Fix typo in unittest docs (GH-97742)
(cherry picked from commit e6f9ec5c03)

Co-authored-by: annonm <annonm@gmail.com>
2022-10-22 20:05:41 +01:00
Miss Islington (bot)
208701e037
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-22 20:05:40 +01:00
Miss Islington (bot)
4f254f6120
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-22 20:05:39 +01:00
Miss Islington (bot)
fb0d9316ef
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-22 20:05:38 +01:00
Miss Islington (bot)
c6bf822a89
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-22 20:05:34 +01:00
Miss Islington (bot)
7ddd0d3194
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-22 20:05:32 +01:00
Miss Islington (bot)
ed772a817e
[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-22 20:05:31 +01:00
Miss Islington (bot)
95f7ed8b07
[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-22 20:05:30 +01:00
Miss Islington (bot)
12bd7e9258
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-22 20:05:18 +01:00
Miss Islington (bot)
5f43097616
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-22 20:05:17 +01:00
Miss Islington (bot)
800c9c0610
[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-22 20:05:16 +01:00
Miss Islington (bot)
33e4537975
[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-22 20:05:14 +01:00
Miss Islington (bot)
c5d6009c41
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-22 20:05:11 +01:00
Miss Islington (bot)
28f97dc9d2
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-22 20:05:11 +01:00
Łukasz Langa
e48d6dfbcd
[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-22 20:05:10 +01:00
Miss Islington (bot)
2af22d2205
[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-22 20:05:08 +01:00
Miss Islington (bot)
bf50f10a6d
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-22 20:05:07 +01:00
Miss Islington (bot)
508ef0f343
[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-22 20:05:06 +01:00
Miss Islington (bot)
3652b26ba1
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-22 20:04:59 +01:00
Miss Islington (bot)
a8a33e16e3
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-22 20:04:58 +01:00
Miss Islington (bot)
40527c2b19
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-22 20:04:57 +01:00
Miss Islington (bot)
c634cd2d8c
[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-22 20:04:55 +01:00
Miss Islington (bot)
e32c7364c6
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-22 20:04:54 +01:00
Miss Islington (bot)
dfae46c665
gh-97822: Fix http.server documentation reference to test() function (GH-98027)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 6b485629d2)

Co-authored-by: JasonYZ <yurenzhang2017@gmail.com>
2022-10-22 20:04:53 +01:00
Miss Islington (bot)
9f3aaef854
gh-56133: copyreg docs: Clarify function/constructor parameter (GH-95497)
(cherry picked from commit 281a3f18cc)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-22 20:04:50 +01:00
Miss Islington (bot)
1f58d8ce78
gh-83940: os docs: Improve wording for getenv/getenvb (GH-98113)
(cherry picked from commit 187e853690)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-22 20:04:47 +01:00
Miss Islington (bot)
e69136baff
[3.11] gh-88452: Add a warning about non-portability of environments. (GH-98155) (GH-98157) 2022-10-22 20:04:46 +01:00
Miss Islington (bot)
7b1be2ac81
gh-96130: Rephrase use of "typecheck" verb for clarity (GH-98144)
I'm sympathetic to the issue report, especially in case this helps
clarify to new users that Python itself does not do type checking at runtime
(cherry picked from commit ed6344eed0)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-10-22 20:04:44 +01:00
Miss Islington (bot)
61e24f3abd
Formatting fixes in contextlib docs (GH-98111)
(cherry picked from commit 3b33c2010a)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-22 20:04:43 +01:00
Miss Islington (bot)
168ec080e8
gh-65046: Link to logging cookbook from asyncio docs (GH-98207)
(cherry picked from commit c39a0c3354)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-10-22 20:04:42 +01:00
Miss Islington (bot)
3737a0e3ab
gh-91485: Doc: Using Python syntax to document builtin Python functions. (GH-96579)
(cherry picked from commit 3c4cbd177f)

Co-authored-by: Julien Palard <julien@palard.fr>
2022-10-22 20:04:39 +01:00
Miss Islington (bot)
be5de50166
Faster sieve() recipe (GH-98287)
(cherry picked from commit f4370318d6)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2022-10-22 20:04:37 +01:00
Miss Islington (bot)
1a84816c30
docs(typing): harmonize "See PEP x for more details" (GH-97927)
(cherry picked from commit 02389658a4)

Co-authored-by: Simon Legner <Simon.Legner@gmail.com>
2022-10-22 20:04:36 +01:00
Miss Islington (bot)
a2820a0ec8
gh-85299: Add note warning about entry point guard for asyncio example (GH-93457)
(cherry picked from commit 79fd6ccdbe)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-22 20:04:34 +01:00
Miss Islington (bot)
335bd1ee8b
gh-94972: document that shield users need to keep a reference to their task (GH-96724)
Co-authored-by: Thomas Grainger <tagrain@gmail.com>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
(cherry picked from commit 6281affee6)

Co-authored-by: Hendrik Makait <hendrik.makait@gmail.com>
2022-09-10 08:03:35 -07:00