Commit Graph

114185 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) 365f9b7b35
gh-95913: Fix and copyedit New Features section of 3.11 What's New (GH-95915)
(cherry picked from commit 8ee27e3318)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-22 20:06:08 +01:00
Miss Islington (bot) 837c1206b2
gh-95913: Copyedit, link & format Typing Features section in 3.11 What's New (GH-96097)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 558768ff22)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-22 20:06:07 +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
Miss Islington (bot) a592f84f50
gh-81039: Add small example of f-string's "=}" to tutorial (gh-92291) (gh-96989)
(cherry picked from commit 4b81139aac)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-22 20:06:04 +01:00
Miss Islington (bot) 50c0a22bc3
gh-96397: Document that keywords in calls need not be identifiers (GH-96393)
This represents the official SC stance, see
https://github.com/python/steering-council/issues/142GH-issuecomment-1252172695
(cherry picked from commit 9d432b4a18)

Co-authored-by: Jeff Allen <ja.py@farowl.co.uk>
2022-10-22 20:06:03 +01:00
Miss Islington (bot) c10f8c8247
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-10-22 20:06:02 +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) 1281d35a8a
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-10-22 20:06:01 +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) 8de353323f
[3.11] gh-65046: Add note about logging from async code. (GH-97602) (GH-97608) 2022-10-22 20:05:57 +01:00
Miss Islington (bot) edc3356277
Fix docs on conditional expression grouping (GH-96447) (GH-97606) 2022-10-22 20:05:56 +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) 807d14baae
closes gh-97650: correct sphinx executable (gh-97651)
(cherry picked from commit 0179a82caa)

Co-authored-by: NoSuck <NoSuck@users.noreply.github.com>
2022-10-22 20:05:53 +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) 815ad02586
[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-10-22 20:05:51 +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) d79a412598
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-22 20:05:48 +01:00
Miss Islington (bot) eb5cdf6246
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-22 20:05:47 +01:00
Miss Islington (bot) 1067baf54b
[3.11] [docs] Update logging cookbook with recipe for using a logger like an output… (GH-97730) (GH-97735) 2022-10-22 20:05:46 +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) 10818aa833
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-22 20:05:44 +01:00
Miss Islington (bot) 5e99363a74
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-22 20:05:43 +01:00
Miss Islington (bot) 1729bec2b5
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-22 20:05:42 +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) d21bef549b
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-22 20:05:37 +01:00
Miss Islington (bot) 4dda0c8173
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-22 20:05:36 +01:00
Miss Islington (bot) 746fb3c91d
Adjust stable ABI internal documentation (GH-96896)
I was perusing this file, and noticed that this part of the documentation is slightly out of date: the `struct` items in this TOML file currently contain `struct_abi_kind` members, which distinguish between the different types of ABI compatibility described in the comment.

I've updated the comment to reflect this.
(cherry picked from commit 6e53308829)

Co-authored-by: William Woodruff <william@yossarian.net>
2022-10-22 20:05:35 +01:00
Miss Islington (bot) e232e49e86
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-22 20:05:35 +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) 9d49bd4773
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-22 20:05:33 +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) 028e7d47cd
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-22 20:05:29 +01:00
Miss Islington (bot) 52709b2099
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-22 20:05:28 +01:00
Miss Islington (bot) 232a40206a
[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-22 20:05:27 +01:00
Miss Islington (bot) 264b615d9b
[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-22 20:05:26 +01:00
Miss Islington (bot) 0679066d94
[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-22 20:05:25 +01:00
Miss Islington (bot) ab665d9b67
[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-22 20:05:24 +01:00