Commit graph

24966 commits

Author SHA1 Message Date
Miss Islington (bot)
bc03bf42e7
gh-97850: Remove the open issues section from the import reference (GH-97935)
Remove the open issues section from the import reference

Tracking in https://github.com/python/cpython/issues/97850 instead.
(cherry picked from commit f8edc6ff53)

Co-authored-by: Brett Cannon <brett@python.org>
2022-10-06 14:07:34 -07:00
Miss Islington (bot)
b7487dff30
gh-86482: Document assignment expression need for ()s (GH-23291)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 2b5f1360ea)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-10-06 12:33:23 -07:00
Łukasz Langa
537c93ea3b
[3.10] gh-93738: Disallow pre-v3 syntax in the C domain (GH-97962) (#97977)
Also, disable using invalid sphinx-lint 0.6.2.
(cherry picked from commit f612565bd3)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-06 11:56:52 -07:00
Miss Islington (bot)
e2591e4f5e
[3.10] gh-95691: Doc BufferedWriter and BufferedReader (GH-95703) (#97948)
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:22:42 -07:00
Miss Islington (bot)
c80c282d11
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:46 -07:00
Miss Islington (bot)
9f1c9b1a7a
[3.10] gh-97654: Add auto exception chaining example to tutorial (GH-97703) (#97884)
Add auto exception chaining example to tutorial
(cherry picked from commit 395b66a0ae)

Co-authored-by: Shahriar Heidrich <smheidrich@weltenfunktion.de>
2022-10-05 14:51:10 -07:00
Łukasz Langa
3b0f2a7ff0
[3.10] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97925)
: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:10:55 -07:00
Miss Islington (bot)
b39182e4b0
[3.10] gh-93738: Documentation C syntax (Function glob patterns -> literal markup) (GH-97774) (#97911)
(cherry picked from commit 0e72606dd4)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-10-05 11:00:50 -07:00
Miss Islington (bot)
de0a656d5b
[3.10] gh-93738: Documentation C syntax (:c:type:PyTypeObject* -> :c:expr:PyTypeObject*) (GH-97778) (#97890)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit c70c8b6976)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-05 08:21:18 -07:00
Łukasz Langa
9aed6bdb20
[3.10] gh-93738: Documentation C syntax (Use c:struct) (GH-97772) (#97893)
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:46 -07:00
Łukasz Langa
d99ea4c7a2
[3.10] gh-93738: Documentation C syntax (:c:type: to :c:expr:, misc. cases) (GH-97775) (#97891)
(cherry picked from commit 6b3d4db02e)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-05 08:19:38 -07:00
Miss Islington (bot)
4245764fae
[3.10] gh-93738: Documentation C syntax (:c:type:PyObject -> :c:expr:PyObject) (GH-97776) (#97888)
: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:17:46 -07:00
Miss Islington (bot)
3c09debaa7
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:56:47 -07:00
Miss Islington (bot)
24908f1f20
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:37:01 -07:00
Miss Islington (bot)
09e5029aca
[3.10] gh-93738: Documentation C syntax (:c:type:PyInterpreterState * -> :c:expr:PyInterpreterState *) (GH-97777) (#97877)
: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:56:46 -07:00
Miss Islington (bot)
95289bf983
[3.10] gh-93738: Documentation C syntax (:c:data:view->obj -> :c:expr:view->obj) (GH-97773) (#97868)
: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:31 -07:00
Miss Islington (bot)
994eaa3a6f
[3.10] gh-93738: Documentation C syntax (:c:type:TYPE -> :c:expr:TYPE) (GH-97770) (#97870)
: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:47:56 -07:00
Miss Islington (bot)
5eedf1d863
[3.10] gh-93738: Documentation C syntax (:c:type:FILE -> :c:expr:FILE) (GH-97769) (#97872)
: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:20 -07:00
Miss Islington (bot)
9c755d7d6b
[3.10] gh-93738: Documentation C syntax (:c:type:PyTupleObject* -> :c:expr:PyTupleObject*) (GH-97780) (#97864)
: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:30 -07:00
Miss Islington (bot)
5aa108b9e0
[3.10] gh-93738: Documentation C syntax (:c:type:PyBytesObject* -> :c:expr:PyBytesObject*) (GH-97782) (#97862)
: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:41:05 -07:00
Miss Islington (bot)
20ddf1c17a
[3.10] gh-93738: Documentation C syntax (:c:type:PyUnicodeObject* -> :c:expr:PyUnicodeObject*) (GH-97783) (#97860)
: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:39:57 -07:00
Miss Islington (bot)
f879297b86
[3.10] gh-93738: Documentation C syntax (:c:type:Py_UNICODE* -> :c:expr:Py_UNICODE*) (GH-97784) (#97858)
: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:39 -07:00
Miss Islington (bot)
a980dafd2c
[3.10] gh-88355: Fix backslashes in AF_PIPE (GH-96543) (#97855)
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:39 -07:00
Miss Islington (bot)
f9b49b6bfa
[3.10] gh-96448: fix documentation for _thread.lock.acquire (GH-96449) (#97852)
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:38 -07:00
Miss Islington (bot)
19ed29ed3c
[3.10] gh-97709: Included newline separator in Mandelbrot set (GH-97737) (#97823)
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-04 12:01:07 -07:00
Miss Islington (bot)
f4e2686b78
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:35 -07:00
Miss Islington (bot)
2911521026
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:14:42 -07:00
Miss Islington (bot)
82ce586f10
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:08 -07:00
Miss Islington (bot)
656983741f
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:17 -07:00
Miss Islington (bot)
280bf3fb16
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:14 -07:00
Miss Islington (bot)
f8a3c4cb83
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 16:00:40 -07:00
Miss Islington (bot)
17b49be003
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:49:16 -07:00
Miss Islington (bot)
e1cbb6f62f
Fix typo in unittest docs (GH-97742)
(cherry picked from commit e6f9ec5c03)

Co-authored-by: annonm <annonm@gmail.com>
2022-10-03 06:42:42 -07:00
Jason R. Coombs
bead571e6a
[3.10] gh-96845: Fix docs around importlib.abc.Traversable (GH-97515)
* [3.10] gh-96845: Correct reference to Traversable* classes.

* [3.10] gh-96845: Add a note about the pending move of resources.abcs.
2022-10-03 09:11:06 -04:00
Miss Islington (bot)
a1711ef030
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 20:59:46 -07:00
Miss Islington (bot)
72d445a22e
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:24:29 -07:00
Miss Islington (bot)
5ee8344aa2
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:27:56 -07:00
Miss Islington (bot)
a4fbb94965
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:24:55 -07:00
Miss Islington (bot)
748b2b780d
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:42 -07:00
Miss Islington (bot)
6d7dbcc0b3
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:53:07 -07:00
Miss Islington (bot)
ba52d01437
[3.10] Use SyntaxError invalid range in tutorial introduction example (GH-93031) (GH-97667)
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:55 +01:00
Miss Islington (bot)
0688f110a6
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:29 -07:00
Miss Islington (bot)
b7b261a8f3
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:03:14 -07:00
Miss Islington (bot)
13f23e013d
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:44:04 -07:00
Miss Islington (bot)
feb4be1553
[3.10] gh-65046: Add note about logging from async code. (GH-97602) (GH-97609) 2022-09-28 05:31:31 +01:00
Miss Islington (bot)
0a7d4359be
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:58 -07:00
Miss Islington (bot)
2e315d87ff
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:23 -07:00
Jia Junjie
6a41d11657
[3.10] gh-97567: Fixup cached_statements default value in sqlite3.connect docs (#97568)
This docs inconsistency was introduced by the 3.10 backport of gh-94629: gh-94646
2022-09-27 09:25:13 +02:00
Miss Islington (bot)
72a78152f3
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:37:38 -07:00
Miss Islington (bot)
8bdaf9bf8e
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:13:04 -07:00