summaryrefslogtreecommitdiffstats
path: root/Doc/library
Commit message (Collapse)AuthorAgeFilesLines
* [3.13] Use roles :data: and :const: for referencing module variables ↵Serhiy Storchaka2025-02-0410-25/+25
| | | | | (GH-129507) (GH-129649) (cherry picked from commit 078ab828b9a21ed0e683941bd141d5017b5f62d9)
* [3.13] gh-128696: Add arm64 to the get_platform return val description ↵Miss Islington (bot)2025-02-031-1/+2
| | | | | | | | | (GH-128701) (#128774) gh-128696: Add arm64 to the get_platform return val description (GH-128701) (cherry picked from commit 553cdc6d6856c1b4539a45eb90d0769f7c629355) Co-authored-by: RUANG (James Roy) <longjinyii@outlook.com>
* [3.13] gh-129407: Clarify that a `SystemError` isn't always CPython's fault ↵Miss Islington (bot)2025-02-031-2/+6
| | | | | | | | (GH-129410) (#129610) gh-129407: Clarify that a `SystemError` isn't always CPython's fault (GH-129410) (cherry picked from commit 39b754a35976924f6df46cd475e889bcf8598ca1) Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
* [3.13] gh-85046: Document errno constants (GH-126420) (#129383)Miss Islington (bot)2025-01-281-0/+165
| | | | | (cherry picked from commit 1c3bb200da77f9df30af4717988dad17db086d1a) Co-authored-by: RUANG (James Roy) <longjinyii@outlook.com>
* [3.13] gh-97850: Remove the mention of removal from `ResourceReader` docs ↵Miss Islington (bot)2025-01-231-1/+1
| | | | | | | | | | (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 a1284e97979ff73ad72ad06c796b904137950576) Co-authored-by: Tomas R <tomas.roun8@gmail.com>
* [3.13] gh-129020: Remove ambiguous sentence from `tokenize.untokenize` docs ↵Miss Islington (bot)2025-01-201-5/+4
| | | | | | | | (GH-129021) (#129035) gh-129020: Remove ambiguous sentence from `tokenize.untokenize` docs (GH-129021) (cherry picked from commit bca35f0e782848ae2acdcfbfb000cd4a2af49fbd) Co-authored-by: Tomas R <tomas.roun8@gmail.com>
* [3.13] gh-121542: Document trailing newline behavior in `set_content()` ↵Miss Islington (bot)2025-01-181-1/+7
| | | | | | | | | (GH-121543) (#128995) gh-121542: Document trailing newline behavior in `set_content()` (GH-121543) (cherry picked from commit fba475ae6f932d0aaee6832b4102b2d4c50df70f) Co-authored-by: Peter Bierma <zintensitydev@gmail.com> Co-authored-by: Yizheng Meng <dev@rapidcow.org>
* [3.13] gh-125997: suggest efficient alternatives for `time.sleep(0)` ↵Miss Islington (bot)2025-01-182-2/+13
| | | | | | | | (GH-128752) (#128984) gh-125997: suggest efficient alternatives for `time.sleep(0)` (GH-128752) (cherry picked from commit f4afaa6f1190fbbea3e27c590096951d8ffdfb71) Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.13] gh-128017: Make a note that sys variables are read-only (GH-128887) ↵Miss Islington (bot)2025-01-171-1/+1
| | | | | | (#128908) Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్ రెడ్డి) <thatiparthysreenivas@gmail.com>
* [3.13] gh-97850: Suggest `TraversableResources` as the alternative for ↵Miss Islington (bot)2025-01-151-1/+3
| | | | | | | | | | | | | `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 256d6d2131541b3ff8f06f42c8157f808fde464c) Co-authored-by: Tomas R <tomas.roun8@gmail.com>
* [3.13] gh-67206: Document that `string.printable` is not printable in the ↵Miss Islington (bot)2025-01-151-3/+10
| | | | | | | | POSIX sense (GH-128820) (#128868) gh-67206: Document that `string.printable` is not printable in the POSIX sense (GH-128820) (cherry picked from commit d906bde250d59c396d8dab92285b832c66cdec27) Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.13] Fix a "doctest" block in `Doc/library/turtle.rst` (GH-128831) (#128835)Miss Islington (bot)2025-01-141-2/+2
| | | | | | Fix a "doctest" block in `Doc/library/turtle.rst` (GH-128831) (cherry picked from commit 1598e18a659ef3a533caa0a79a489a3ed1d80bdd) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
* [3.13] gh-123345: improve `fnmatch` docs (GH-123346) (#128776)Miss Islington (bot)2025-01-131-6/+12
| | | | | | gh-123345: improve `fnmatch` docs (GH-123346) (cherry picked from commit 29fe8072cf404b891dde9c1d415095edddbe19de) Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.13] gh-128409: Document that pdb.post_mortem() accepts exceptions … ↵Tian Gao2025-01-131-5/+7
| | | | | | | | | (#128767) * [3.13] gh-128409: Document that pdb.post_mortem() accepts exceptions (GH-128410) (cherry picked from commit 1b39b502d33c68f52fd775c4e6c2174baddd40bd) Co-authored-by: Adam Johnson <me@adamj.eu> Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
* [3.13] gh-124433: fix docs for `asyncio.Queue.task_done` (GH-128669) (#128671)Miss Islington (bot)2025-01-091-3/+3
| | | | | | gh-124433: fix docs for `asyncio.Queue.task_done` (GH-128669) (cherry picked from commit 4322a318ea98ceeb95d88b7ae6b5cfa3572d2069) Co-authored-by: Kumar Aditya <kumaraditya@python.org>
* [3.13] gh-126137: improve docs for `loop.add_reader` and `loop.add_writer` ↵Miss Islington (bot)2025-01-091-0/+6
| | | | | | | | (GH-128666) (#128667) gh-126137: improve docs for `loop.add_reader` and `loop.add_writer` (GH-128666) (cherry picked from commit b2adf556747d080f04b53ba4063b627c2dbe41d1) Co-authored-by: Kumar Aditya <kumaraditya@python.org>
* [3.13] gh-79149: document reentrant safety of `loop.call_soon_threadsafe` ↵Miss Islington (bot)2025-01-091-0/+3
| | | | | | | | | (GH-128662) (#128664) gh-79149: document reentrant safety of `loop.call_soon_threadsafe` (GH-128662) (cherry picked from commit 4685401845ba3e2ab8c9f4a9a10aa2969b11985f) Co-authored-by: Kumar Aditya <kumaraditya@python.org> Co-authored-by: Thomas Grainger <tagrain@gmail.com>
* [3.13] gh-87506: Document that json.load*() can raise UnicodeDecodeError ↵Miss Islington (bot)2025-01-081-6/+6
| | | | | | | | | (GH-127355) (#128607) (cherry picked from commit 15372d0112ac7fbbbe313725dd87d5a45af2f6d3) (cherry picked from commit cdfb8bc93a4d8c06d2404ba2d243937ba209438c) Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్ రెడ్డి) <thatiparthysreenivas@gmail.com> Co-authored-by: Erlend Aasland <erlend@python.org>
* [3.13] Docs: mark up json.load() using parameter list (GH-128488) (#128596)Miss Islington (bot)2025-01-071-44/+69
| | | | | (cherry picked from commit a21e31ec5417374497b0f969ee2b3dc84a0944ff) Co-authored-by: Erlend E. Aasland <erlend@python.org>
* [3.13] gh-108202: Document calendar.Calendar.firstweekday (GH-128566) (#128579)Miss Islington (bot)2025-01-071-4/+16
| | | | | (cherry picked from commit b3cbd8f1b58b9e71df20bdda9960e7d3190c509e) Co-authored-by: Erlend E. Aasland <erlend@python.org>
* [3.13] gh-108202: Document `calendar.Calendar` methods `getfirstweekday` and ↵Miss Islington (bot)2025-01-061-0/+8
| | | | | | | `setfirstweekday` (GH-127579) (#128564) (cherry picked from commit 953b49e5468d02afaddadc2307f4763422078603) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
* [3.13] gh-114990: Add missing mixin methods in collections.abc's document ↵Miss Islington (bot)2025-01-061-2/+3
| | | | | | | (GH-114991) (#128535) Co-authored-by: AN Long <aisk@users.noreply.github.com> Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
* [3.13] Docs: fix `MessageDefect` references in email.policy docs (GH-128468) ↵Miss Islington (bot)2025-01-051-2/+2
| | | | | | | (#128526) (cherry picked from commit 3b231be8f000ae59faa04d5a2f1af11beafee866) Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
* [3.13] Docs: amend json.dump() post gh-128482 (GH-128489) (#128493)Miss Islington (bot)2025-01-041-5/+8
| | | | | (cherry picked from commit 87ee76062a7eb9c0fa2b94e36cfed21d86ae90ac) Co-authored-by: Erlend E. Aasland <erlend@python.org>
* [3.13] gh-126719: Clarify math.fmod docs (GH-127741) (#128491)Miss Islington (bot)2025-01-041-1/+2
| | | | | | (cherry picked from commit f28d471fbe99f9eaac05d60ed40da47b0b56fe86) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.13] Docs: mark up json.dump() using parameter list (GH-128482) (#128486)Miss Islington (bot)2025-01-041-48/+70
| | | | | | (cherry picked from commit a0088b40bb212dc132e147d04f9287cabd72d163) Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.13] gh-108202: Document calendar.TextCalendar formatting helpers ↵Miss Islington (bot)2025-01-031-1/+26
| | | | | | | | | | | | | (GH-127608) (#128440) Document the following TextCalendar methods: - formatday() - formatmonthname() - formatweekday() - formatweekheader() (cherry picked from commit bb73426cafb78691b249ffa50f1872ab6f899d4a) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
* [3.13] gh-128349: Use `.. data::` instead of `.. class::` for pre-defined ↵Miss Islington (bot)2025-01-021-3/+3
| | | | | | | | 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 60c65184695a3eab766b3bc26fc99f695deb998f) Co-authored-by: abkmystery <36216019+abkmystery@users.noreply.github.com>
* [3.13] gh-128317: Document `calendar.TextCalendar.formatweek` (GH-128353) ↵Miss Islington (bot)2024-12-301-0/+8
| | | | | | (#128357) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.13] gh-112328: Make EnumDict usable on its own and document it ↵Ethan Furman2024-12-241-2/+27
| | | | | | (GH-123669) (GH-128142) Co-authored-by: Petr Viktorin <pviktori@redhat.com>
* [3.13] gh-126180: Remove getopt and optparse deprecation notices (GH-128191)Miss Islington (bot)2024-12-238-39/+211
| | | | | | | | | | | | | | | * 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 831b6de6d725c697f2f61fd35c4448cd8a9354ff) Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.13] gh-122706: fix docs for asyncio ssl sockets (GH-128092) (#128094)Miss Islington (bot)2024-12-191-2/+2
| | | | | | gh-122706: fix docs for asyncio ssl sockets (GH-128092) (cherry picked from commit 19c5134d57764d3db7b1cacec4f090c74849a5c1) Co-authored-by: Kumar Aditya <kumaraditya@python.org>
* [3.13] Minor readability improvements for the itertools recipes (gh-127928) ↵Miss Islington (bot)2024-12-161-39/+35
| | | | (gh-127999)
* [3.13] Simplify and speed-up an itertools recipe (gh-127848) (gh-127998)Miss Islington (bot)2024-12-161-6/+6
|
* [3.13] Fix typo in itertools docs (gh-127995) (gh-127996)Miss Islington (bot)2024-12-161-1/+1
|
* [3.13] Clarify ast docs to use a less confusing example for `ast.ParamSpec` ↵Miss Islington (bot)2024-12-151-2/+2
| | | | | | | | | | (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 7900a85019457c14e8c6abac532846bc9f26760d) Co-authored-by: Steve C <diceroll123@gmail.com>
* [3.13] gh-127852: add remark about ',' separator (GH-127854) (#127941)Miss Islington (bot)2024-12-141-1/+3
| | | | | | | | | Specify that it is valid for floats and ints with 'd' presentation and an error otherwise. --------- (cherry picked from commit e2325c9db0650fc06d909eb2b5930c0573f24f71) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* [3.13] link to the correct output method in documentation (GH-127857) (#127900)Miss Islington (bot)2024-12-131-1/+1
| | | | | | link to the correct output method in documentation (GH-127857) (cherry picked from commit 11ff3286b7e821bf439bc7caa0fa712e3bc3846a) Co-authored-by: Viktor Kálmán <kviktor@users.noreply.github.com>
* [3.13] Fix typo in traceback docs (GH-127884) (#127890)Miss Islington (bot)2024-12-121-1/+1
| | | | Co-authored-by: Daniel Haag <121057143+denialhaag@users.noreply.github.com>
* [3.13] Docs: Fix indents in `xmlrpc.client.rst` (GH-127782) (#127799)Miss Islington (bot)2024-12-101-4/+4
| | | | | | Docs: Fix indents in `xmlrpc.client.rst` (GH-127782) (cherry picked from commit 035f512046337e64a018d11fdaa3b21758625291) Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
* [3.13] gh-101100: Fix sphinx warnings in `whatsnew/3.0.rst` (GH-127662) ↵Miss Islington (bot)2024-12-101-0/+3
| | | | | | (#127783) Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.13] gh-127347: Document `traceback.print_list` (GH-127348) (#127569)Miss Islington (bot)2024-12-041-0/+7
| | | | | Add an documentation entry about `traceback.print_list` Co-authored-by: Tomas R. <tomas.roun8@gmail.com>
* [3.13] Itertool recipe additions (gh-127483) (gh-127585)Miss Islington (bot)2024-12-041-0/+37
|
* Python 3.13.1v3.13.1Thomas Wouters2024-12-031-1/+1
|
* [3.13] gh-122838: Document missing opcodes (GH-123073) (#126492)Miss Islington (bot)2024-12-021-0/+21
| | | | | | gh-122838: Document missing opcodes (GH-123073) (cherry picked from commit 9cba47d9f151734815a61e32391ea7fca877ea55) Co-authored-by: Kamil Turek <kamil.turek@hotmail.com>
* [3.13] gh-99880: document rounding mode for new-style formatting (GH-121481) ↵Miss Islington (bot)2024-12-021-0/+5
| | | | | | | | | | | | | | | | | (#126334) The CPython uses _Py_dg_dtoa(), which does rounding to nearest with half to even tie-breaking rule. If that functions is unavailable, PyOS_double_to_string() fallbacks to system snprintf(). Since CPython 3.12, build requirements include C11 compiler *and* support for IEEE 754 floating point numbers (Annex F). This means that FE_TONEAREST macro is available and, per default, printf-like functions should use same rounding mode as _Py_dg_dtoa(). (cherry picked from commit 7d7d56d8b1147a6b85e1c09d01b164df7c5c4942) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.13] gh-101100: Fix Sphinx warnings about list methods (GH-127054) (#127511)Miss Islington (bot)2024-12-021-2/+2
| | | | Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
* [3.13] gh-127303: Add docs for token.EXACT_TOKEN_TYPES (GH-127304) (#127390)Miss Islington (bot)2024-11-301-0/+7
| | | | | | | | | | | | gh-127303: Add docs for token.EXACT_TOKEN_TYPES (GH-127304) --------- (cherry picked from commit dd3a87d2a8f8750978359a99de2c5cb2168351d1) Co-authored-by: Илья Любавский <100635212+lubaskinc0de@users.noreply.github.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Tomas R. <tomas.roun8@gmail.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.13] Link to correct class methods in asyncio primitives docs (GH-127270) ↵Miss Islington (bot)2024-11-291-4/+4
| | | | | | | | (#127423) Link to correct class methods in asyncio primitives docs (GH-127270) (cherry picked from commit 15d6506d175780bb29e5fcde654e3860408aa93e) Co-authored-by: Ollanta Cuba Gyllensten <ollantaster@gmail.com>
* [3.13] Fix indentation for contextlib.asynccontextmanager docs (GH-127333) ↵Miss Islington (bot)2024-11-271-3/+3
| | | | | | | | (#127334) Fix indentation for contextlib.asynccontextmanager docs (GH-127333) (cherry picked from commit 9328db7652677a23192cb51b0324a0fdbfa587c9) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>