Commit graph

25647 commits

Author SHA1 Message Date
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)
d03f45203b
gh-95913: Copyedit/improve Implementation Changes What's New section (GH-97720)
* Add and refine reST/Sphinx syntax for implementation changes section

* Clarify and refine wording in the Implementation Changes section

* Elide unnecessary comma

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 4e731814d7)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-04 18:08:59 -07:00
Miss Islington (bot)
98e250bed1
[3.11] gh-93738: Documentation C syntax (:c:data:view->obj -> :c:expr:view->obj) (GH-97773) (#97867)
:c:data:`view->obj` -> :c:expr:`view->obj`
(cherry picked from commit fa59bda8d3)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-04 17:55:17 -07:00
Miss Islington (bot)
76c50d784f
[3.11] gh-93738: Documentation C syntax (:c:type:PyInterpreterState * -> :c:expr:PyInterpreterState *) (GH-97777) (#97865)
:c:type:`PyInterpreterState *` -> :c:expr:`PyInterpreterState *`
(cherry picked from commit 4ebb025031)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-04 17:53:48 -07:00
Miss Islington (bot)
3ec11d92fd
[3.11] gh-93738: Documentation C syntax (:c:type:TYPE -> :c:expr:TYPE) (GH-97770) (#97874)
:c:type:`TYPE` -> :c:expr:`TYPE`
(cherry picked from commit 8b211b4cdb)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-04 17:48:24 -07:00
Miss Islington (bot)
1b7da7f088
[3.11] gh-93738: Documentation C syntax (:c:type:FILE -> :c:expr:FILE) (GH-97769) (#97871)
:c:type:`FILE` -> :c:expr:`FILE`
(cherry picked from commit 192d401ba5)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-04 17:47:02 -07:00
Miss Islington (bot)
a51124729a
[3.11] gh-93738: Documentation C syntax (:c:type:PyTupleObject* -> :c:expr:PyTupleObject*) (GH-97780) (#97863)
:c:type:`PyTupleObject*` -> :c:expr:`PyTupleObject*`
(cherry picked from commit 510baa429a)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-04 16:46:13 -07:00
Miss Islington (bot)
df133f54ef
[3.11] gh-93738: Documentation C syntax (:c:type:PyBytesObject* -> :c:expr:PyBytesObject*) (GH-97782) (#97861)
:c:type:`PyBytesObject*` -> :c:expr:`PyBytesObject*`
(cherry picked from commit 9ebc50866b)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-04 16:40:47 -07:00
Miss Islington (bot)
9749c6029e
[3.11] gh-93738: Documentation C syntax (:c:type:PyUnicodeObject* -> :c:expr:PyUnicodeObject*) (GH-97783) (#97859)
:c:type:`PyUnicodeObject*` -> :c:expr:`PyUnicodeObject*`
(cherry picked from commit 898834e27b)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-04 16:38:58 -07:00
Miss Islington (bot)
1657c837f3
[3.11] gh-93738: Documentation C syntax (:c:type:Py_UNICODE* -> :c:expr:Py_UNICODE*) (GH-97784) (#97857)
:c:type:`Py_UNICODE*` -> :c:expr:`Py_UNICODE*`
(cherry picked from commit a081cae2a2)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-04 16:38:24 -07:00
Miss Islington (bot)
a13b4e8ca6
gh-95913: Copyedit/improve Other Language Changes What's New section (GH-97719)
* Add/refine cross references to items in other lang changes section

* Unify context manager exception changes into single non-repetitive item

* More clearly describe the intent and consequences of the -P option

* Apply minor clarifications & copyedits to rest of section

* Tweak the formatting of module references

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit a77d9dedcd)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-04 16:24:50 -07:00
Miss Islington (bot)
a685cc0a5e
gh-95913: Move py.exe to appropriate What's New section & refine text (GH-97718)
* Move Windows py.exe improvements from Typing section to New Features

* Add ref target label and use literal for py.exe

* Be clearer/explict about what legacy version arg components reprisent

* Apply other minor clarity and textual fixes to py.exe launcher text

* Refine phrasing of legacy sentence of py.exe desc

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 985958187d)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-04 15:58:59 -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)
dcec9b70c9
GH-95913: Update what's new in 3.11 for asyncio (GH-97806)
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 9fbfa42ece)

Co-authored-by: Guido van Rossum <guido@python.org>
2022-10-04 11:45:02 -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)
3263aaf83f
gh-97754: Update doc for default location of per-user installs on Windows (GH-97756)
(cherry picked from commit a120b9f25d)

Co-authored-by: Ben Faulhaber <111227622+faulhaberben@users.noreply.github.com>
2022-10-04 09:13:37 -07:00
Miss Islington (bot)
c62be23f04
gh-97709: Included newline separator in Mandelbrot set (GH-97737)
Included newline separator in Mandelbrot set

Now the Mandelbrot set one-liner example on separates the lines with a '\n' character.
(cherry picked from commit 49802605f8)

Co-authored-by: matheusja <matheusjahnke@hotmail.com>
2022-10-03 22:43:00 -07:00
Miss Islington (bot)
e34b00cc3e
gh-93738: Documentation C syntax (:c:data:0 -> `0`) (GH-97771)
:c:data:`0` -> ``0``
(cherry picked from commit 5e997cff3e)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-03 18:55:04 -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)
3db036888c
gh-95913: Fix PEP number in PEP 678 What's New ref label (GH-97739)
What's New: Fix PEP number in PEP 678 ref target label
(cherry picked from commit e738b5190b)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-02 21:21:46 -07:00
Miss Islington (bot)
2049c9db15
gh-95913: Copyedit/improve New Modules What's New section (GH-97721)
* Link TOML & WSGI in New Modules section, refine text & add ref label

* Further reformat new modules & add PEP link to tomllib
(cherry picked from commit bd00112a99)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-02 21:11:05 -07:00
Miss Islington (bot)
827f77e5f1
gh-97740: Fix bang in Sphinx C domain ref target syntax (GH-97741)
* gh-97740: Fix bang in Sphinx C domain ref target syntax

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

* Add NEWS entry for C domain bang fix

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
(cherry picked from commit 9148c0d893)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-02 21:02:46 -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)
011260bca0
[3.11] [docs] Update logging cookbook with recipe for using a logger like an output… (GH-97730) (GH-97735) 2022-10-02 17:44:42 +01:00
Miss Islington (bot)
8c528ef4a1
gh-97607: Fix content parsing in the impl-detail reST directive (GH-97652)
* Don't parse content as arg in the impl-detail directive

This does not change the (untranslated) output,
but ensures that the doctree node metadata is correct.
which fixes gh-97607 with the text not being translated.
It also simplifies the code and logic
and makes it consistant with the docutils built-in directives.

* Remove unused branch from impl-detail directive handling no-content case

This is not used anywhere in the docs and lacks a clear use case,
and is more likely a mistake which is now flagged at build time.
This simplifies the logic from two code paths to one,
and makes the behavior consistant with similar built-in directives
(e.g. the various admonition types).

* Further simplify impl-detail reST directive code
(cherry picked from commit e8165d47b8)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-01 22:28:54 -07:00
Miss Islington (bot)
1fa848ac39
gh-95975: Move except/*/finally ref labels to more precise locations (GH-95976)
* gh-95975: Move except/*/finally ref labels to more precise locations

* Add section headers to fix :keyword: role and aid navigation

* Move see also to the introduction rather than a particular subsection

* Fix other minor Sphinx syntax issues with except

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

* Suppress redundant link to same section for except too

* Don't link try/except/else/finally keywords if in the same section

* Format try/except/finally as keywords in modified sections

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit dcc82331c8)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-01 22:20:43 -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)
1a620c579d
[3.11] Use SyntaxError invalid range in tutorial introduction example (GH-93031) (GH-97666)
Use SyntaxError invalid range in tutorial introduction example (GH-93031)

Use output from a 3.10+ REPL, showing invalid range, for the
SyntaxError examples in the tutorial introduction page.

Co-authored-by: Eddie Hebert <eddie@eddiehebert.com>
2022-09-30 10:12:22 +01: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)
bad137bd93
closes gh-97650: correct sphinx executable (gh-97651)
(cherry picked from commit 0179a82caa)

Co-authored-by: NoSuck <NoSuck@users.noreply.github.com>
2022-09-29 16:00:33 -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)
88ab19e47e
Fix docs on conditional expression grouping (GH-96447) (GH-97606) 2022-09-28 08:45:48 -05:00
Miss Islington (bot)
73557d5bd2
[3.11] gh-65046: Add note about logging from async code. (GH-97602) (GH-97608) 2022-09-28 05:32:01 +01: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)
cf61fa278e
gh-82530: Create blank function instead of invalid import for email example (GH-97529)
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
(cherry picked from commit 2b428a1fae)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-09-25 21:15:52 -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)
c29d9b599f
gh-75608: Add Windows FAQ entry for missing UCRT (GH-92765)
(cherry picked from commit 80bc7d7c0a)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-09-23 03:54:53 -07:00