Commit graph

25722 commits

Author SHA1 Message Date
Miss Islington (bot)
24e8d0cf70
[3.11] gh-95913: Edit & expand Optimizations in 3.11 WhatsNew (GH-98426) (#98554)
gh-95913: Edit & expand Optimizations in 3.11 WhatsNew (GH-98426)
(cherry picked from commit f58631be11)

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

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-22 20:18:57 +01:00
Miss Islington (bot)
3cd39e9399
[Enum docs]: fix order of arguments to isinstance() (GH-98542)
(cherry picked from commit 327fc1c6fa)

Co-authored-by: Clément Robert <cr52@protonmail.com>
2022-10-22 04:36:01 -07:00
Miss Islington (bot)
c835b97c5f
gh-51511: Note that codecs.open()'s encoding parameter affects automatic conversion to binary mode (GH-94370)
(cherry picked from commit d9407b174c)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-21 16:27:41 -07:00
Miss Islington (bot)
68f25e261e
bpo-2716: add license for audioop module (GH-19972)
(cherry picked from commit 4c1145bb37)

Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
2022-10-21 16:07:30 -07:00
Miss Islington (bot)
31d23ae894
gh-98298: [Enum] document ReprEnum, global_enum, and show_flag_values (GH-98455)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 3e95ffc7ae)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2022-10-21 15:43:23 -07:00
Miss Islington (bot)
0bc2cf9915
gh-98172: [doc] mention that except* handles naked exceptions (GH-98496)
(cherry picked from commit 8367ca136e)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-10-21 03:43:56 -07:00
Hugo van Kemenade
095e06f4ca
[3.11] Docs: Bump sphinx-lint and use double backticks for inline literals (GH-98441) (#98445)
Bump sphinx-lint and use double backticks for inline literals
2022-10-20 06:07:33 -07:00
Miss Islington (bot)
860efa3534
[3.11] [doc] Improve logging cookbook example. (GH-98481) (GH-98483)
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2022-10-20 12:54:52 +01:00
Vinay Sajip
3b7e0204bf
[3.11] [doc] Refresh the venv introduction documentation, and correct the st… (GH-98465)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Phil Elson <pelson.pub@gmail.com>
2022-10-19 22:28:24 +01:00
Miss Islington (bot)
f0c0d309c3
Doc: Remove title text from internal links (GH-98409)
Rely on the title of the linked internal page instead of putting the title. Sphinx will render with the title correctly, and this will reduce work for translators
(cherry picked from commit 52fcba6512)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2022-10-19 08:44:05 -07:00
Raymond Hettinger
07cc997e00
[3.11] Sync the batched() recipe with the 3.12 implementation (GH-98446) 2022-10-19 09:21:14 -05:00
Miss Islington (bot)
1b7922e058
gh-95913: Edit zipfile Whatsnew section & add new APIs (GH-98314)
* Link ZipFile in What's New entry discussing it

* Add entry for new ZipFile.mkdir method

* Add entry for new zipfile.Path.stem/suffix/suffixes methods

* Add missing line breaks between zipfile bullet list items
(cherry picked from commit ed827d5608)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-18 21:40:47 -07:00
Miss Islington (bot)
202eb48a76
gh-95913: Add WhatsNew section for new logging APIs (GH-98320)
* Add entry for new logging.getLevelNamesMapping function

* Add entry for SysLogHandler.createSocket to whatsnew

* Add missing line break between logging bullet list items
(cherry picked from commit 251b8ccd2a)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-18 21:34:40 -07:00
Miss Islington (bot)
75357cdcf1
gh-95914: Add links to 3.11 WhatsNew Summary items (GH-98416)
Add links to Summary items to where readers can learn more
(cherry picked from commit fcae1954a2)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-18 16:20:19 -07:00
Miss Islington (bot)
f1a240abab
General improvements to the itertools docs (GH-98408)
(cherry picked from commit f4ead4874b)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2022-10-18 12:17:40 -07:00
Miss Islington (bot)
d798b595ff
gh-95913: Copyedit, xref and organize enum section (GH-98295)
* Whatsnew: Convert literals in enum section to actual x-references

* Whatsnew: Rewrite enum section for clear and consistant phrasing

* Whatsnew: Combine directly related enum items instead of seperating them

* gh-98250: Describe __str__/__format__ changes more clearly/accurately

* Tweak enum section language per feedback from Ethan
(cherry picked from commit 73e5180faf)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-18 02:34:47 -07:00
Miss Islington (bot)
c84d4cee02
gh-95913: Prepare remaining Whatsnew sections for editing (GH-98342)
* Add line breaks & ref targets to Whatsnew to prepare for future changes

* Use standard heading underbar symbols for H4 sections

* Flatten Porting subsection; clarify scope of/link Python->CAPI sections

* Move C API pending deprecations to C API section, to match the others
(cherry picked from commit 0a0c7e5a7a)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-18 01:53:52 -07:00
C.A.M. Gerlach
ea19c28512
[3.11] Docs: Fix backtick errors found by sphinx-lint (GH-97998) (#98371)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>.
(cherry picked from commit fa2d43e518)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-10-18 01:49:38 +02:00
Miss Islington (bot)
9cb30bb339
Move random selection recipes from itertools.rst to random.rst (GH-98369)
(cherry picked from commit 70732d8a4c)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2022-10-17 15:38:22 -07:00
Miss Islington (bot)
6c7f7ec819
gh-85525: Remove extra row in doc (GH-98337)
* remove extra row

* 📜🤖 Added by blurb_it.

Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
(cherry picked from commit 5c9302d03a)

Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
2022-10-17 15:08:10 -07:00
Miss Islington (bot)
f4a0b80250
gh-95914: Add What's New item describing PEP 670 changes (GH-98315)
(cherry picked from commit aafc53c0a6)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-17 12:25:18 -07:00
Miss Islington (bot)
211b8193ca
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-16 12:41:41 -07:00
Vinay Sajip
f64e26c04e
[3.11] gh-98307: Add docstring and documentation for SysLogHandler.cr… (GH-98325)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-16 18:45:59 +01:00
Miss Islington (bot)
e26c526fd4
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-16 10:16:48 -07:00
Miss Islington (bot)
a2ae35dfa4
[3.11] Improve speed. Reduce auxiliary memory to 16.6% of the main array. (GH-98294) (GH-98303) 2022-10-15 16:24:05 -05:00
Vinay Sajip
79c0adeb1d
[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-15 21:51:58 +01:00
Miss Islington (bot)
d3b57dc729
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-15 12:25:58 -07:00
Miss Islington (bot)
42511fc72d
Faster sieve() recipe (GH-98287)
(cherry picked from commit f4370318d6)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2022-10-15 10:52:45 -07:00
Miss Islington (bot)
c0083e6470
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-15 09:12:18 -07:00
Miss Islington (bot)
232a988912
gh-85525: Indicate supported sound header formats (GH-21575)
* Indicate supported sound header formats

* modify file names

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 05c042e707)

Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
2022-10-15 08:09:20 -07:00
Miss Islington (bot)
42d536c1c7
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-15 07:32:37 -07:00
Miss Islington (bot)
450306ed67
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-12 09:13:24 -07:00
Miss Islington (bot)
b2f037cce7
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-12 09:08:56 -07:00
Miss Islington (bot)
316590116a
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-11 21:51:13 -07:00
Miss Islington (bot)
59ddbc4ab6
Formatting fixes in contextlib docs (GH-98111)
(cherry picked from commit 3b33c2010a)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-11 21:05:12 -07:00
Miss Islington (bot)
9e666bc640
gh-95276: Add callable entry to the glossary (GH-95738)
(cherry picked from commit e3bf125c81)

Co-authored-by: MonadChains <monadchains@gmail.com>
2022-10-11 19:50:25 -07:00
Miss Islington (bot)
d22c35dfff
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-11 19:45:44 -07:00
Miss Islington (bot)
9b12084aca
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-11 09:22:04 -07:00
Miss Islington (bot)
5c0d4c2619
[3.11] gh-88452: Add a warning about non-portability of environments. (GH-98155) (GH-98157) 2022-10-10 21:10:04 +01:00
Miss Islington (bot)
fc14f1a80d
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-10 07:01:05 -07:00
Miss Islington (bot)
a2f728038e
doc: remove a misleading statement. (GH-98093)
(cherry picked from commit 571e23d991)

Co-authored-by: Julien Palard <julien@palard.fr>
2022-10-10 01:50:26 -07:00
Miss Islington (bot)
4172e09c3a
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-09 18:03:53 -07:00
Miss Islington (bot)
6211bb2cf8
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-09 18:02:00 -07:00
Miss Islington (bot)
6554598236
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-08 19:03:25 -07:00
Miss Islington (bot)
9828ccb63b
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-08 00:01:27 -07:00
Miss Islington (bot)
b5196faff3
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-07 22:07:06 -07:00
Miss Islington (bot)
8d6591b593
gh-57179: Add note on symlinks for os.walk (GH-94799)
(cherry picked from commit 0f498f1a95)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-07 20:00:04 -07:00
Miss Islington (bot)
c2f21af42a
gh-65496: Correct wording on csv's skipinitialspace argument (GH-96170)
(cherry picked from commit 676d8ef380)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-07 16:45:53 -07:00
Miss Islington (bot)
17c9ce112f
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-07 16:05:52 -07:00
Miss Islington (bot)
40d5e89d3b
[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-07 13:53:15 -07:00