Commit graph

25619 commits

Author SHA1 Message Date
Ł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)
82f663b7f0
[3.11] gh-97654: Add auto exception chaining example to tutorial (GH-97703) (#97885)
gh-97654: Add auto exception chaining example to tutorial (GH-97703)

Add auto exception chaining example to tutorial
(cherry picked from commit 395b66a0ae)

Co-authored-by: Shahriar Heidrich <smheidrich@weltenfunktion.de>
2022-10-22 20:05:09 +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)
bf1de26199
[3.11] gh-93738: Disallow pre-v3 syntax in the C domain (GH-97962) (#97976)
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>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-10-22 20:05:05 +01:00
Miss Islington (bot)
cc10a8e81c
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-22 20:05:04 +01:00
Barry Warsaw
a3df8d7141
[3.11] Backport effc25f 3.11 (#97991)
* Add Pynche's move to the What's new in 3.11 (#97974)

* Add Pynche's move to the What's new in 3.11

* Update Doc/whatsnew/3.11.rst

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

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

* [3.11] Add Pynche's move to the What's new in 3.11 (GH-97974)

* Add Pynche's move to the What's new in 3.11

* Update Doc/whatsnew/3.11.rst

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

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

Co-authored-by: Barry Warsaw <barry@python.org>
2022-10-22 20:05:03 +01:00
Miss Islington (bot)
35b94b7ce2
[3.11] Docs: pin sphinx-lint (GH-97992) (GH-97993) 2022-10-22 20:05:02 +01:00
Miss Islington (bot)
d994584d6f
[3.11] gh-97850: Remove the open issues section from the import reference (GH-97935) (GH-97994)
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>

Automerge-Triggered-By: GH:brettcannon
2022-10-22 20:05:01 +01:00
Miss Islington (bot)
47e920d9c0
[3.11] Remove extra spaces in custom openSSL documentation. (GH-93568) (#98007)
Remove extra spaces in custom openSSL documentation. (GH-93568)
(cherry picked from commit 4875433682)

Co-authored-by: Xiao Chen <chenxiao_7@163.com>

Co-authored-by: Xiao Chen <chenxiao_7@163.com>
2022-10-22 20:05:00 +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)
517ffe0a29
[3.11] gh-96959: Update HTTP links which are redirected to HTTPS (GH-98039) (#98049)
(cherry picked from commit c81c64ca58)

Co-authored-by: 180909 <734461790@qq.com>
2022-10-22 20:04:56 +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)
9b6afbee2e
gh-97913 Docs: Add walrus operator to the index (GH-97921)
* Add walrus operator to the index

* Add named expression to the index

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>

* Fix indentation and add missing newline

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

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 296313002f)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-10-22 20:04:52 +01:00
Miss Islington (bot)
7460cf43ba
Minor edits to the Descriptor HowTo Guide (GH-24901)
Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
(cherry picked from commit 2d2e01aa4c)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2022-10-22 20:04:51 +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)
979440e96f
Fix types in buffer/memoryview docs (GH-98118)
The definition of obj in the `Py_buffer` struct is as a PyObject*
ec091bd47e/Include/pybuffer.hGH-L22

PyMemoryView_GET_BASE returns `.obj` - thus its return type
should be a PyObject* (or at least a void*). It definitely
doesn't return `Py_buffer`
(cherry picked from commit c459fedf7c)

Co-authored-by: da-woods <dw-git@d-woods.co.uk>
2022-10-22 20:04:49 +01:00
Miss Islington (bot)
7b803ec344
doc: remove a misleading statement. (GH-98093)
(cherry picked from commit 571e23d991)

Co-authored-by: Julien Palard <julien@palard.fr>
2022-10-22 20:04:48 +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)
e0260d03f7
gh-98172: Fix formatting in except* docs (GH-98173)
(cherry picked from commit 5ecf961640)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-10-22 20:04:45 +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)
37d165904d
gh-95276: Add callable entry to the glossary (GH-95738)
(cherry picked from commit e3bf125c81)

Co-authored-by: MonadChains <monadchains@gmail.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)
b63602303e
tutorial: remove "with single quotes" (GH-98204)
Closes GH-91856.

On Windows double quotes are sometimes better, on Unix usually
single quotes. It's not our place to explain that, so just don't.
(cherry picked from commit 5f8ca1b796)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-10-22 20:04:41 +01:00
Miss Islington (bot)
0f3c5ab039
gh-96265: Formatting changes for faq/general (GH-98129)
* Some formatting changes for general faq

* Use list for Python versioning

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

* New line for list, list for a/b/rc

* Line wrap for 80 chars

* More line wrap

* Remove PythonWin mention.

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit e9569ec43e)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-22 20:04:40 +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)
f96dbab7d8
gh-98227: executionmodel.rst: except* can also bind names (GH-98256)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 146f168fbf)

Co-authored-by: BiscuitCandy <70342294+BiscuitCandy@users.noreply.github.com>
2022-10-22 20:04:38 +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
Vinay Sajip
77000c82f9
[3.11] [doc] Update logging cookbook with an example of custom handli… (GH-98296)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-10-22 20:04:35 +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)
c6df6eecd8
GH-91415: Mention alphabetical sort ordering in the Sorting HOWTO (GH-98336)
(cherry picked from commit ae19217867)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2022-10-22 20:04:33 +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
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
Miss Islington (bot)
ae819ca6fd
[3.11] gh-68163: Correct conversion of Rational instances to float (GH-25619) (#96556)
Co-authored-by: Mark Dickinson <dickinsm@gmail.com>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2022-09-08 12:03:53 +01:00
Miss Islington (bot)
a3d5ecba1c
[3.11] gh-88287: Add BufferingFormatter documentation. (GH-96608) (GH-96675) 2022-09-08 08:30:48 +01:00
Miss Islington (bot)
08d8058b79
gh-96559: Fixes Windows launcher handling of defaults using old-style tags, and adds What's New section (GH-96595)
(cherry picked from commit 80a9bd2e94)

Co-authored-by: Steve Dower <steve.dower@python.org>
2022-09-05 15:13:24 -07:00
Irit Katriel
a5a9d0517b
[3.11] [doc] Update example in traceback doc (GH-96600) (GH-96603)
This Monty Python reference is of-its-time. It could seem inappropriate in the context of today's sensibilities around mental health.

Automerge-Triggered-By: GH:iritkatriel
(cherry picked from commit c4999f261f)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-09-05 22:43:27 +01:00
Miss Islington (bot)
d09069abfe
[3.11] gh-84095: Fill documentation gap regarding user-defined objects. (GH-96574) (GH-96575) 2022-09-05 08:03:49 +01:00
Miss Islington (bot)
0c81909a7a
Docs: alphabetically order sqlite3.Cursor attrs (GH-96565)
(cherry picked from commit 9e55685782)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-09-04 14:43:23 -07:00
Miss Islington (bot)
4587154cb9
gh-95778: remove unneeded doc note on float.as_integer_ratio (GH-96553)
Per mdickinson@'s comment on the main branch PR.
(cherry picked from commit 69bb83c2bf)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2022-09-04 00:12:00 -07:00
Miss Islington (bot)
c0af099816
doc typo: spell limitation (GH-96542)
(cherry picked from commit af6359dd5c)

Co-authored-by: Mehrdad Moradizadeh <mhrddmoradii@gmail.com>
2022-09-03 23:32:32 -07:00
Miss Islington (bot)
79fe67fa04
[3.11] gh-89087: Update logging.QueueHandler documentation to clarify record… (GH-96527) (GH-96528) 2022-09-03 13:16:40 +01:00