Commit Graph

13525 Commits

Author SHA1 Message Date
Miss Islington (bot) e5ee784a7c
[3.13] gh-130106: Fix a typo in unittest.mock doc (GH-130107) (#130143)
gh-130106: Fix a typo in unittest.mock doc (GH-130107)
(cherry picked from commit d2e60d8e59)

Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్  రెడ్డి) <thatiparthysreenivas@gmail.com>
2025-02-15 03:37:05 +00:00
Andrew Svetlov 7b0543ebe6
[3.13] gh-128308: pass `**kwargs` to asyncio task_factory (GH-128768) (#130084)
* [3.13] gh-128308: pass `**kwargs` to asyncio task_factory (GH-128768)
(cherry picked from commit 38a9956876)

Co-authored-by: Thomas Grainger <tagrain@gmail.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>


---------

Co-authored-by: Thomas Grainger <tagrain@gmail.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2025-02-14 22:04:17 +05:30
Miss Islington (bot) 36790830cb
[3.13] gh-101100: Docs: Fix some typos in the document (GH-129988) (#129997)
Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-02-11 21:37:25 +00:00
Miss Islington (bot) e5c522e895
[3.13] gh-97850: Update the deprecation warning of `importlib.abc.Loader.load_module` (GH-129855) (GH-130013)
gh-97850: Update the deprecation warning of `importlib.abc.Loader.load_module` (GH-129855)
(cherry picked from commit aa81a6f6e4)

Co-authored-by: Tomas R <tomas.roun8@gmail.com>
2025-02-11 19:28:25 +00:00
Miss Islington (bot) a00f5a84fd
[3.13] gh-129143: Fix incorrect documentation for logging.Handler.close(). (GH-129950) (GH-129951)
(cherry picked from commit 7c156a63d3)
2025-02-10 11:26:50 +00:00
Miss Islington (bot) f7d885a8ff
[3.13] gh-129873: IDLE: Improve help.py's method of parsing HTML (GH-129859) (#129884)
gh-129873: IDLE: Improve help.py's method of parsing HTML (GH-129859)

In `help.copy_strip`, only copy the text `<section>`.  In `help.HelpParser.handle_starttag` and elsewhere, remove code to skip the no longer present html.  Add a reminder at the top of idle.rst to run copy_strip after changes.
---------

(cherry picked from commit 6fbf15f98e)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2025-02-09 04:19:36 -05:00
Miss Islington (bot) 3cf859056a
[3.13] gh-129699: Add description to IDLE doc title (GH-129727) (#129864)
gh-129699: Add description to IDLE doc title (GH-129727)

Also extend the 'idlelib' section header. These additions affect both the displayed idle.html file and the contents.html file displayed by clicking the Complete table of contents link on the main docs.python.org page. (The module index entries are generated from the module name and synopsis within module files.)
---------

(cherry picked from commit 33a7094aa6)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2025-02-08 20:14:47 +00:00
Miss Islington (bot) 9497e9d77d
[3.13] gh-64414: mention AF_INET6 and IPv6 in socketserver docs. (GH-129866) (#129868)
gh-64414: mention AF_INET6 and IPv6 in socketserver docs. (GH-129866)

mention AF_INET6 and IPv6 in socketserver docs.
(cherry picked from commit 5ce70ad129)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2025-02-08 20:12:22 +00:00
Miss Islington (bot) aae0a1f904
[3.13] Add multinomial to the itertools recipes docs (gh-129760) (gh-129762) 2025-02-06 18:45:15 -06:00
Miss Islington (bot) de84531a3e
[3.13] gh-112020: Rework socketserver examples to be correct (GH-129741) (#129743)
gh-112020: Rework socketserver examples to be correct.

Outdated code updated, the BaseRequestHandler example is now much more
illustrative instead of the bad idea of a single recv() call for TCP.

tested, they now work.
(cherry picked from commit 78377c788e)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2025-02-06 17:49:19 +00:00
Miss Islington (bot) 0f7e6d78ea
[3.13] Remove an inaccurate note from `socket.recv` (GH-129733) (#129734)
Remove an inaccurate note from `socket.recv` (GH-129733)

Remove an inaccurate note from socket.recv.
(cherry picked from commit ded54c3baa)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2025-02-06 09:45:28 -08:00
Serhiy Storchaka 4cf3e80eee
[3.13] Use roles :data: and :const: for referencing module variables (GH-129507) (GH-129649)
(cherry picked from commit 078ab828b9)
2025-02-04 14:25:18 +00:00
Miss Islington (bot) 646bd7958e
[3.13] gh-128696: Add arm64 to the get_platform return val description (GH-128701) (#128774)
gh-128696: Add arm64 to the get_platform return val description (GH-128701)
(cherry picked from commit 553cdc6d68)

Co-authored-by: RUANG (James Roy) <longjinyii@outlook.com>
2025-02-03 23:56:23 +00:00
Miss Islington (bot) 85e162087f
[3.13] gh-129407: Clarify that a `SystemError` isn't always CPython's fault (GH-129410) (#129610)
gh-129407: Clarify that a `SystemError` isn't always CPython's fault (GH-129410)
(cherry picked from commit 39b754a359)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-02-03 11:52:29 +00:00
Miss Islington (bot) 332426b4af
[3.13] gh-85046: Document errno constants (GH-126420) (#129383)
(cherry picked from commit 1c3bb200da)

Co-authored-by: RUANG (James Roy) <longjinyii@outlook.com>
2025-01-28 00:19:06 +00:00
Miss Islington (bot) eed7865cee
[3.13] gh-97850: Remove the mention of removal from `ResourceReader` docs (GH-128602) (#128654)
gh-97850: Remove the mention of removal from `ResourceReader` docs (GH-128602)

Remove the mention of removal from ResourceReader docs
(cherry picked from commit a1284e9797)

Co-authored-by: Tomas R <tomas.roun8@gmail.com>
2025-01-23 22:17:32 +01:00
Miss Islington (bot) 080d17e945
[3.13] gh-129020: Remove ambiguous sentence from `tokenize.untokenize` docs (GH-129021) (#129035)
gh-129020: Remove ambiguous sentence from `tokenize.untokenize` docs (GH-129021)
(cherry picked from commit bca35f0e78)

Co-authored-by: Tomas R <tomas.roun8@gmail.com>
2025-01-20 00:11:27 +00:00
Miss Islington (bot) b7ddcc3efb
[3.13] gh-121542: Document trailing newline behavior in `set_content()` (GH-121543) (#128995)
gh-121542: Document trailing newline behavior in `set_content()` (GH-121543)
(cherry picked from commit fba475ae6f)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Yizheng Meng <dev@rapidcow.org>
2025-01-18 18:40:30 +00:00
Miss Islington (bot) fff334e538
[3.13] gh-125997: suggest efficient alternatives for `time.sleep(0)` (GH-128752) (#128984)
gh-125997: suggest efficient alternatives for `time.sleep(0)` (GH-128752)
(cherry picked from commit f4afaa6f11)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-01-18 11:08:42 +00:00
Miss Islington (bot) 9974e7185d
[3.13] gh-128017: Make a note that sys variables are read-only (GH-128887) (#128908)
Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్  రెడ్డి) <thatiparthysreenivas@gmail.com>
2025-01-17 18:04:00 +02:00
Miss Islington (bot) 714b85136b
[3.13] gh-97850: Suggest `TraversableResources` as the alternative for `ResourceLoader` (GH-128601) (GH-128895)
gh-97850: Suggest `TraversableResources` as the alternative for `ResourceLoader` (GH-128601)

Suggest TraversableResources as the alternative for ResourceLoader.

Previously, ResourceReader was the suggested alternative, but it
is itself deprecated in favour of TraversableResources.
(cherry picked from commit 256d6d2131)

Co-authored-by: Tomas R <tomas.roun8@gmail.com>
2025-01-15 20:53:17 +00:00
Miss Islington (bot) 639e0f36af
[3.13] gh-67206: Document that `string.printable` is not printable in the POSIX sense (GH-128820) (#128868)
gh-67206: Document that `string.printable` is not printable in the POSIX sense (GH-128820)
(cherry picked from commit d906bde250)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-01-15 14:27:27 +00:00
Miss Islington (bot) 0998eb6275
[3.13] Fix a "doctest" block in `Doc/library/turtle.rst` (GH-128831) (#128835)
Fix a "doctest" block in `Doc/library/turtle.rst` (GH-128831)
(cherry picked from commit 1598e18a65)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2025-01-14 15:28:01 +00:00
Miss Islington (bot) 05bd6cbe61
[3.13] gh-123345: improve `fnmatch` docs (GH-123346) (#128776)
gh-123345: improve `fnmatch` docs (GH-123346)
(cherry picked from commit 29fe8072cf)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-01-13 10:35:26 +00:00
Tian Gao 33c0ba0ead
[3.13] gh-128409: Document that pdb.post_mortem() accepts exceptions … (#128767)
* [3.13] gh-128409: Document that pdb.post_mortem() accepts exceptions (GH-128410)
(cherry picked from commit 1b39b502d3)

Co-authored-by: Adam Johnson <me@adamj.eu>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-01-13 00:12:11 -05:00
Miss Islington (bot) c57ef49337
[3.13] gh-124433: fix docs for `asyncio.Queue.task_done` (GH-128669) (#128671)
gh-124433: fix docs for `asyncio.Queue.task_done` (GH-128669)
(cherry picked from commit 4322a318ea)

Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2025-01-09 18:00:55 +05:30
Miss Islington (bot) 1d2d62c15e
[3.13] gh-126137: improve docs for `loop.add_reader` and `loop.add_writer` (GH-128666) (#128667)
gh-126137: improve docs for `loop.add_reader` and `loop.add_writer` (GH-128666)
(cherry picked from commit b2adf55674)

Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2025-01-09 10:16:59 +00:00
Miss Islington (bot) 4f01a120f7
[3.13] gh-79149: document reentrant safety of `loop.call_soon_threadsafe` (GH-128662) (#128664)
gh-79149: document reentrant safety of `loop.call_soon_threadsafe` (GH-128662)
(cherry picked from commit 4685401845)

Co-authored-by: Kumar Aditya <kumaraditya@python.org>
Co-authored-by: Thomas Grainger <tagrain@gmail.com>
2025-01-09 09:25:18 +00:00
Miss Islington (bot) 0cd603689a
[3.13] gh-87506: Document that json.load*() can raise UnicodeDecodeError (GH-127355) (#128607)
(cherry picked from commit 15372d0112)
(cherry picked from commit cdfb8bc93a)

Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్  రెడ్డి) <thatiparthysreenivas@gmail.com>
Co-authored-by: Erlend Aasland <erlend@python.org>
2025-01-08 08:48:55 +00:00
Miss Islington (bot) 984cdb788e
[3.13] Docs: mark up json.load() using parameter list (GH-128488) (#128596)
(cherry picked from commit a21e31ec54)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2025-01-07 21:13:25 +00:00
Miss Islington (bot) 8f3e5554ba
[3.13] gh-108202: Document calendar.Calendar.firstweekday (GH-128566) (#128579)
(cherry picked from commit b3cbd8f1b5)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2025-01-07 08:05:09 +00:00
Miss Islington (bot) d81b99b53b
[3.13] gh-108202: Document `calendar.Calendar` methods `getfirstweekday` and `setfirstweekday` (GH-127579) (#128564)
(cherry picked from commit 953b49e546)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-01-07 00:45:26 +01:00
Miss Islington (bot) aa519e4cae
[3.13] gh-114990: Add missing mixin methods in collections.abc's document (GH-114991) (#128535)
Co-authored-by: AN Long <aisk@users.noreply.github.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2025-01-06 10:03:05 +00:00
Miss Islington (bot) 838e8a2718
[3.13] Docs: fix `MessageDefect` references in email.policy docs (GH-128468) (#128526)
(cherry picked from commit 3b231be8f0)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
2025-01-05 22:04:39 +00:00
Miss Islington (bot) 62b4ca0d53
[3.13] Docs: amend json.dump() post gh-128482 (GH-128489) (#128493)
(cherry picked from commit 87ee76062a)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2025-01-04 19:03:01 +00:00
Miss Islington (bot) 65fd758098
[3.13] gh-126719: Clarify math.fmod docs (GH-127741) (#128491)
(cherry picked from commit f28d471fbe)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-01-04 17:44:36 +00:00
Miss Islington (bot) ff7ef94e6e
[3.13] Docs: mark up json.dump() using parameter list (GH-128482) (#128486)
(cherry picked from commit a0088b40bb)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-01-04 15:49:57 +00:00
Miss Islington (bot) e0f0d2d2b8
[3.13] gh-108202: Document calendar.TextCalendar formatting helpers (GH-127608) (#128440)
Document the following TextCalendar methods:
- formatday()
- formatmonthname()
- formatweekday()
- formatweekheader()

(cherry picked from commit bb73426caf)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-01-03 10:03:45 +00:00
Miss Islington (bot) 48d50fd491
[3.13] gh-128349: Use `.. data::` instead of `.. class::` for pre-defined decimal `Context` objects (GH-128379) (#128401)
gh-128349: Use `.. data::` instead of `.. class::` for pre-defined decimal `Context` objects (GH-128379)
(cherry picked from commit 60c6518469)

Co-authored-by: abkmystery <36216019+abkmystery@users.noreply.github.com>
2025-01-02 07:28:12 +00:00
Miss Islington (bot) 207a81ac19
[3.13] gh-128317: Document `calendar.TextCalendar.formatweek` (GH-128353) (#128357)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-12-30 19:40:29 +02:00
Ethan Furman 875e49fb63
[3.13] gh-112328: Make EnumDict usable on its own and document it (GH-123669) (GH-128142)
Co-authored-by: Petr Viktorin <pviktori@redhat.com>
2024-12-24 10:50:23 -08:00
Miss Islington (bot) 6f3c2c8d04
[3.13] gh-126180: Remove getopt and optparse deprecation notices (GH-128191)
* Remove getopt and optparse deprecation notices
* Add new docs sections for command line app helper libraries
* Add guidance on choosing a CLI parsing library to the optparse docs
* Link to the new guidance from the argparse and getopt docs
* Reword intro in docs section for superseded stdlib modules
* Reframe the optparse->argparse guide as a migration guide
  rather than as an upgrade guide

---------
(cherry picked from commit 831b6de6d7)

Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-12-23 04:40:59 +00:00
Miss Islington (bot) f8e7b5cc8d
[3.13] gh-122706: fix docs for asyncio ssl sockets (GH-128092) (#128094)
gh-122706: fix docs for asyncio ssl sockets (GH-128092)
(cherry picked from commit 19c5134d57)

Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2024-12-19 18:26:05 +05:30
Miss Islington (bot) 71a1e79134
[3.13] Minor readability improvements for the itertools recipes (gh-127928) (gh-127999) 2024-12-16 17:33:20 +00:00
Miss Islington (bot) 28e684b330
[3.13] Simplify and speed-up an itertools recipe (gh-127848) (gh-127998) 2024-12-16 11:26:58 -06:00
Miss Islington (bot) 231c93923d
[3.13] Fix typo in itertools docs (gh-127995) (gh-127996) 2024-12-16 11:20:14 -06:00
Miss Islington (bot) 89f4b23f9e
[3.13] Clarify ast docs to use a less confusing example for `ast.ParamSpec` (GH-127955) (#127959)
Clarify ast docs to use a less confusing example for `ast.ParamSpec` (GH-127955)

Fix typo in ast docs: ParamSpec defaults
(cherry picked from commit 7900a85019)

Co-authored-by: Steve C <diceroll123@gmail.com>
2024-12-15 12:35:25 +00:00
Miss Islington (bot) 9c6bd272b4
[3.13] gh-127852: add remark about ',' separator (GH-127854) (#127941)
Specify that it is valid for floats and ints with 'd' presentation and an error otherwise.
---------

(cherry picked from commit e2325c9db0)

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-12-14 13:34:18 +00:00
Miss Islington (bot) 8384279863
[3.13] link to the correct output method in documentation (GH-127857) (#127900)
link to the correct output method in documentation (GH-127857)
(cherry picked from commit 11ff3286b7)

Co-authored-by: Viktor Kálmán <kviktor@users.noreply.github.com>
2024-12-13 15:07:46 +05:30
Miss Islington (bot) d3d478eff1
[3.13] Fix typo in traceback docs (GH-127884) (#127890)
Co-authored-by: Daniel Haag <121057143+denialhaag@users.noreply.github.com>
2024-12-12 21:51:10 +00:00