Commit graph

25628 commits

Author SHA1 Message Date
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
Miss Islington (bot)
9eb1e6c692
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-09-22 11:18:02 -07:00
Miss Islington (bot)
ad49555d51
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-09-21 09:11:48 -04: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)
bda451b794
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-09-19 06:51:08 -07:00
Miss Islington (bot)
58247c5b86
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-09-19 06:45:35 -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)
f09c33c44e
Add dataclass field default change to 3.11 what's new (GH-96790)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
(cherry picked from commit 4995f5f9a0)

Co-authored-by: Laurie O <laurie_opperman@hotmail.com>
2022-09-13 13:53:11 -07: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
Christian Heimes
bc337a7766
[3.11] gh-96005: Handle WASI ENOTCAPABLE in getpath (GH-96006) (GH-96034) (GH-96038)
- On WASI `ENOTCAPABLE` is now mapped to `PermissionError`.
- The `errno` modules exposes the new error number.
- `getpath.py` now ignores `PermissionError` when it cannot open landmark
  files `pybuilddir.txt` and `pyenv.cfg`.
2022-09-13 13:00:45 +02: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
Miss Islington (bot)
1276e73787
gh-95914: Add paragraph about PEP 654 in main body of 'What's New in 3.11' (GH-95937)
(cherry picked from commit 1402d2ceca)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-09-08 04:16:52 -07:00