summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* [3.12] gh-102136: Add -m to options that work with -i (GH-119271) (GH-119286)Miss Islington (bot)2025-04-081-3/+9
| | | | | | (cherry picked from commit 172690227e771c2e8ab137815073e3a172c08dec) Co-authored-by: Melanie Arbor <hellomelaniec@gmail.com> Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
* [3.12] gh-132021: Add bool type to the list of allowed JSON key types ↵Miss Islington (bot)2025-04-081-2/+2
| | | | | | | | | (GH-132048) (#132256) gh-132021: Add bool type to the list of allowed JSON key types (GH-132048) (cherry picked from commit 403886c28ddb350bbcaea478f8d754ed14e10337) Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్ రెడ్డి) <thatiparthysreenivas@gmail.com> Co-authored-by: Eric V. Smith <ericvsmith@users.noreply.github.com>
* [3.12] gh-116608: undeprecate functional importlib.resources API (#132206)Thomas Grainger2025-04-081-34/+17
| | | Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
* [3.12] gh-115684: Clarify datetime `replace` documentation (GH-116519) (#131694)David Lowry-Duda2025-04-081-10/+10
| | | | | | | | | | | | | | | | | | | | | | | | | * Clarify datetime `replace` documentation In GH-115684, HopedForLuck noted that `datetime.date.replace()` documentation was confusing because it looked like it would be changing immutable objects. This documentation change specifies that the `replace()` methods in `datetime` return new objects. This uses similar wording to the documentation for `datetime.combine()`, which specifies that a new datetime is returned. This is also similar to wording for `string.replace()`, except `string.replace()` emphasizes that a "copy" is returned. Resolves GH-115684. * Include reviewer comments Thanks Privat33r-dev for the comments! --------- (cherry picked from commit d2d886215cf694d5f3e7f0cbd76507a96bac322b) Co-authored-by: Paul Ganssle <1377457+pganssle@users.noreply.github.com>
* [3.12] Add psfhosted Plausible instance to analytics (GH-132252) (#132254)Miss Islington (bot)2025-04-081-0/+1
| | | | | | Add psfhosted Plausible instance to analytics (GH-132252) (cherry picked from commit 40844164b1d1d0f072990ff94202c348771676d6) Co-authored-by: Ee Durbin <ewdurbin@gmail.com>
* [3.12] gh-130521: Add Open Graph meta tags to template pages (GH-130523) ↵Miss Islington (bot)2025-04-073-0/+37
| | | | | | | | | | (#132238) gh-130521: Add Open Graph meta tags to template pages (GH-130523) (cherry picked from commit f5639d87f59043d3075dbd3d9075f30e872dd91a) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.12] Docs HTML: Remove self-closing tags (GH-132220) (#132229)Hugo van Kemenade2025-04-074-22/+22
| | | | | (cherry picked from commit ce724571b35f4e79fff1c862fcd9afa4c26b605f) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* [3.12] gh-132221: Fix `__match_args__` generation docs in `dataclasses.rst` ↵Miss Islington (bot)2025-04-071-4/+7
| | | | | | | | (GH-132222) (#132227) gh-132221: Fix `__match_args__` generation docs in `dataclasses.rst` (GH-132222) (cherry picked from commit 8b62374b344f5da852bed9f16619736d4d43936b) Co-authored-by: sobolevn <mail@sobolevn.me>
* [3.12] gh-131912: Improve description of grouping options in the format ↵Miss Islington (bot)2025-04-071-33/+55
| | | | | | | specification docs (GH-132030) (#132203) (cherry picked from commit 06a110f5227ba9d52f6205fde55924a14cab36ff) Co-authored-by: Prometheus3375 <35541026+Prometheus3375@users.noreply.github.com>
* [3.12] Docs: Add a single table summary for ``cmath`` (GH-131887) (#132180)Miss Islington (bot)2025-04-061-0/+51
| | | | | | | | | | Docs: Add a single table summary for ``cmath`` (GH-131887) (cherry picked from commit 6eaa4aeef25f77a31768d8ba5a03f614766aba95) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
* [3.12] Fix numbered list syntax in programming.rst (GH-130158) (#132141)Miss Islington (bot)2025-04-051-5/+5
| | | | | | Fix numbered list syntax in programming.rst (GH-130158) (cherry picked from commit 376631829aab72e320e19102fc55cbca5af8c733) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
* [3.12] Docs: document `plistlib.InvalidFileException` (GH-132069) (#132117)Miss Islington (bot)2025-04-051-2/+10
| | | | | | Docs: document `plistlib.InvalidFileException` (GH-132069) (cherry picked from commit 99e9798d612222785db427eb295c847147fe5e78) Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
* [3.12] Minor improvements to the programming FAQ (GH-127261) (#131965)Miss Islington (bot)2025-04-011-7/+7
| | | | | | | Minor improvements to the programming FAQ (GH-127261) (cherry picked from commit 23a658b9af410b72beeb28ba4ace2d83896c5631) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] gh-125957: sync argument naming in sphinx docs of the cmath and ↵Miss Islington (bot)2025-04-011-50/+50
| | | | | | | | | help() (GH-125958) (#131963) gh-125957: sync argument naming in sphinx docs of the cmath and help() (GH-125958) (cherry picked from commit 0a3eb8855ccea52c618db1cf09840c6368a3745f) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.12] gh-131885: Document that `dict.setdefault` and `dict.get` take no ↵Miss Islington (bot)2025-03-301-2/+2
| | | | | | | | keyword arguments (GH-128208) (#131894) gh-131885: Document that `dict.setdefault` and `dict.get` take no keyword arguments (GH-128208) (cherry picked from commit edfbd8c062285e83dc5f596288df2a762e68bcdc) Co-authored-by: Adam Dangoor <adamdangoor@gmail.com>
* [3.12] gh-129994: update docs when using `dualstack_ipv6` in ↵Miss Islington (bot)2025-03-301-4/+4
| | | | | | | | `socket.create_server` (GH-129996) (#131891) gh-129994: update docs when using `dualstack_ipv6` in `socket.create_server` (GH-129996) (cherry picked from commit 044a1e13d5cfc91b0a8774e936877e91cbac3a16) Co-authored-by: Alexander Ershov <150328014+AEErshov@users.noreply.github.com>
* [3.12] gh-127541: Update os.walk example (GH-127765) (#131873)Miss Islington (bot)2025-03-291-8/+8
| | | | | | | | | gh-127541: Update os.walk example (GH-127765) Update os.walk example to be more modern, skip `__pycache__` dirs rather than `CVS` dirs. (cherry picked from commit a5949986d631391d37b1b329ad8badcf2000f9a9) Co-authored-by: Totosuki <116938397+totosuki@users.noreply.github.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.12] Fix typo in importlib.metadata.rst (gh-131596) (#131631)Miss Islington (bot)2025-03-271-1/+1
| | | | | | Fix typo in importlib.metadata.rst (gh-131596) (cherry picked from commit 5fc889ffbfd271c651f563ab0afe2d345bacbca5) Co-authored-by: Zsolt Dollenstein <zsol.zsol@gmail.com>
* [3.12] gh-131741: Add documentation for Windows version detection change in ↵Miss Islington (bot)2025-03-261-0/+8
| | | | | | | | | | | | | `platform` (GH-131742) (#131768) gh-131741: Add documentation for Windows version detection change in `platform` (GH-131742) Document the behavior change between 3.11 & 3.12, where ``platform`` now correctly detects Windows 11 and Windows Server releases past Windows Server 2012. (cherry picked from commit b9ca438daab6a4e2513ab38171e94c75da03d6e3) Co-authored-by: Idan Noiman <idann@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Wulian <1055917385@qq.com>
* [3.12] gh-130283: update deprecated links and examples in `urllib.request` ↵Miss Islington (bot)2025-03-231-14/+15
| | | | | | | | | docs (GH-130284) (#131627) gh-130283: update deprecated links and examples in `urllib.request` docs (GH-130284) (cherry picked from commit fd459b115330b089da26a0555f45afced597942a) Co-authored-by: Kanishk Pachauri <itskanishkp.py@gmail.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.12] gh-121529: Document `from_` parameter in `_mboxMMDF` public methods ↵Miss Islington (bot)2025-03-231-2/+27
| | | | | | | | (GH-121530) (#131622) gh-121529: Document `from_` parameter in `_mboxMMDF` public methods (GH-121530) (cherry picked from commit 557d2d20d484a7b22da39cdb876f6312ab66d561) Co-authored-by: Sebb <sebbASF@users.noreply.github.com>
* [3.12] gh-131457: Fix typo in BNF description of function signatures ↵Miss Islington (bot)2025-03-221-1/+1
| | | | | | | | (GH-131460) (#131576) gh-131457: Fix typo in BNF description of function signatures (GH-131460) (cherry picked from commit 8b7d20d3a9dc53344e3803507deafc26b5c09ca8) Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్ రెడ్డి) <thatiparthysreenivas@gmail.com>
* [3.12] gh-70647: update docs to mention the datetime 1900 year default 2/29 ↵Gregory P. Smith2025-03-211-3/+23
| | | | | | | | | | | | | | issue (#131534) * gh-70647: Better promote how to safely parse yearless dates in datetime. Every four years people encounter this because it just isn't obvious. This moves the footnote up to a note with a code example. We'd love to change the default year value for datetime but doing that could have other consequences for existing code. This documented workaround *always* works. * doctest code within note is bad, dedent.
* [3.12] GH-121970: Extract `pydoc_topics` into a new extension (GH-131256) ↵Adam Turner2025-03-201-1/+1
| | | | | (#131512) (cherry picked from commit c1a02f9101f0b2d9dc7cfb4b8be5193e7459a906)
* [3.12] Docs: Fix documentation for "PyTypeObject Definition" (GH-130936) ↵Miss Islington (bot)2025-03-201-1/+1
| | | | | | | | | (GH-131459) The structure definition for `PyTypeObject` is in `Include/cpython/object.h`, not in `Include/object.h`. (cherry picked from commit a0478c9f0c6d6a75ca35a8dc2c74d3b58877f094) Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
* [3.12] gh-131417: Mention asyncio Future and Task in docs for generic ↵Miss Islington (bot)2025-03-191-0/+2
| | | | | | | | | | classes list (GH-131422) (#131446) gh-131417: Mention asyncio Future and Task in docs for generic classes list (GH-131422) Mention asyncio Future and Task in docs for generic classes list (cherry picked from commit 61b4b2c57c9327273f2e306bafa23cf2c70eac8e) Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
* [3.12] Docs: fix shell command formatting (GH-131310) (#131444)Miss Islington (bot)2025-03-191-1/+1
| | | | | | | | Docs: fix shell command formatting (GH-131310) replace "zypper in" with "zypper install" to avoid incorrect highlighting (cherry picked from commit 267c06d6a8290aa299098b4fcd3f270001b01e72) Co-authored-by: partev <petrosyan@gmail.com>
* [3.12] gh-116666: Add "token" glossary term (GH-130888) (GH-131368)Miss Islington (bot)2025-03-184-11/+28
| | | | | | | | | | | | | gh-116666: Add "token" glossary term (GH-130888) Add glossary entry for `token`, and link to it. Avoid talking about tokens in the SyntaxError intro (errors.rst); at this point tokenization is too much of a technical detail. (Even to an advanced reader, the fact that a *single* token is highlighted isn't too relevant. Also, we don't need to guarantee that it's a single token.) (cherry picked from commit 30d52058493e07fd1d3efea960482f4001bd2f86) Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] gh-131002: clarify how to enforce sqlite3 column types for generated ↵Miss Islington (bot)2025-03-181-18/+21
| | | | | | | fields (GH-131006) (#131386) (cherry picked from commit f48887fb97651c02c5e412a75ed8b51a4ca11e6a) Co-authored-by: Erlend E. Aasland <erlend@python.org>
* [3.12] gh-130132: properly free resources in `urrlib.urlopen` examples ↵Miss Islington (bot)2025-03-181-5/+13
| | | | | | | | | | (GH-130280) (#131395) gh-130132: properly free resources in `urrlib.urlopen` examples (GH-130280) (cherry picked from commit 77d2fd441320ca365c34e21c475d3878f3d5d833) Co-authored-by: Kanishk Pachauri <itskanishkp.py@gmail.com> Co-authored-by: sobolevn <mail@sobolevn.me> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.12] gh-131094: Refine `math.isclose` docs (GH-131139) (#131393)Miss Islington (bot)2025-03-181-2/+2
| | | | | | gh-131094: Refine `math.isclose` docs (GH-131139) (cherry picked from commit 3f50f96586d46497e4d9de065c4424fe2d72508e) Co-authored-by: Guy Jacoby <49398101+guyjacoby@users.noreply.github.com>
* [3.12] gh-129675: Update documentation for tp_basicsize & tp_itemsize ↵Miss Islington (bot)2025-03-173-30/+83
| | | | | | | | | | | | | | | | | | (GH-129850) (GH-131078) - Add alignment requirement - Mention that ob_size is unreliable if you don't control it - Add some links for context - basicsize should include the base type in generaly not just PyObject - suggest Py_SIZE & Py_SET_SIZE This adds a “by-the-way” link to `PyObject_New`, which shouldn't be used for GC types. In order to be comfortable linking to it, I also add a link to `PyObject_GC_New` from its docs. And the same for `*Var` variants, while I'm here. (cherry picked from commit ad0f618ab3eb1f26f8830a863aaf7bb70835c00d) Co-authored-by: Petr Viktorin <encukou@gmail.com>
* [3.12] gh-124385: Document and soft-deprecate PyLong_AS_LONG (GH-124386) ↵Hugo van Kemenade2025-03-171-0/+10
| | | | | | | (#130549) (cherry picked from commit 425587a110eb214a097c634d4b6d944ac478923e) Co-authored-by: Petr Viktorin <encukou@gmail.com>
* [3.12] gh-109961: Docs: Fix incorrect rendering of `__replace__` in ↵Hugo van Kemenade2025-03-172-8/+16
| | | | | | | `copy.rst` (GH-109968) (#130909) (cherry picked from commit 0baf72696e79191241a2d5cfdfd7e6135115f7b2) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.12] gh-130160: use `.. program::` directive for documenting `http.server` ↵donBarbos2025-03-171-48/+65
| | | | | CLI (GH-131010) (#131294) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.12] gh-131327: Document winsound.SND_APPLICATION (GH-131328) (#131329)Miss Islington (bot)2025-03-161-0/+7
| | | | | | | gh-131327: Document winsound.SND_APPLICATION (GH-131328) (cherry picked from commit bf4c1bf344ed1f80c4e8f4fd5b1a8f0e0858777e) Co-authored-by: AN Long <aisk@users.noreply.github.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.12] gh-130160: use `.. program::` directive for documenting `doctest` CLI ↵Miss Islington (bot)2025-03-162-25/+47
| | | | | | | | | (GH-131034) (#131321) gh-130160: use `.. program::` directive for documenting `doctest` CLI (GH-131034) (cherry picked from commit 9558d22ac308c102e4f843541eead2022050225e) Co-authored-by: donBarbos <donbarbos@proton.me> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.12] gh-130814: Enhance documentation for Python C API type objects ↵Miss Islington (bot)2025-03-141-2/+2
| | | | | | | | | | | | (GH-130817) (#131224) gh-130814: Enhance documentation for Python C API type objects (GH-130817) The "Type Objects" title in `c-api/typeobj.rst`, duplicating the title of `c-api/type.rst`, has been changed to "Type Objects Structures", thereby slightly improving Sphinx search. (cherry picked from commit 6b932edc5216d9766e70fef300a6b842ab33204c) Co-authored-by: sharktide <meherrihaan@gmail.com>
* [3.12] gh-124269: Simplify `typing.Annotated` docs (GH-130770) (#131223)Miss Islington (bot)2025-03-141-47/+33
| | | | | | | | | | gh-124269: Simplify `typing.Annotated` docs (GH-130770) --------- (cherry picked from commit e4ac196aaaa9fd2f1bd0050797b58959671c549a) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.12] gh-101100: Fix sphinx warnings in `library/asyncio-subprocess.rst` ↵Yuki Kobayashi2025-03-112-11/+10
| | | | | (GH-130994) (#131075) (cherry picked from commit 7cc99a54b755cc7cc0b3680fde7834cf612d4fbc)
* [3.12] gh-130711: Document `PyBaseObject_Type` (GH-130712) (GH-130793)Miss Islington (bot)2025-03-101-0/+5
| | | | | | (cherry picked from commit b3c18bfd828ba90b9c712da74095c4a052887655) Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com> Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
* [3.12] gh-80421: Correct definitions of time (GH-130984) (#131023)Miss Islington (bot)2025-03-091-3/+7
| | | | | | | | gh-80421: Correct definitions of time (GH-130984) Based on the Wikipedia article, UTC is better said to be a successor than a renaming of GTC and language agnostic rather than an English-French compromise. (cherry picked from commit 98fa4a49fecbac3c990a25ce5d300592dad31be0) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
* [3.12] gh-130160: use `.. program::` directive for documenting `pdb` CLI ↵Miss Islington (bot)2025-03-091-8/+17
| | | | | | | | (GH-130996) (#131013) gh-130160: use `.. program::` directive for documenting `pdb` CLI (GH-130996) (cherry picked from commit c240c2d88a080fc3c68c220aa81062cf5f130ab9) Co-authored-by: donBarbos <donbarbos@proton.me>
* [3.12] gh-130160: use `.. program::` directive for documenting `webbrowser` ↵donBarbos2025-03-091-3/+15
| | | | | | | | | | | CLI (GH-130995) (#131004) * gh-130160: use `.. program::` directive for documenting `webbrowser` CLI (#130995) use `.. program::` directive for documenting `webbrowser` CLI (cherry picked from commit 92e5f826ace1eab29920a0a3487a3cac7eeab925) * remove extra paragraph
* [3.12] gh-123726: Document caveats of zipfile.Path around name sanitization ↵Miss Islington (bot)2025-03-081-0/+8
| | | | | | | | | | (GH-130537) (#130987) gh-123726: Document caveats of zipfile.Path around name sanitization (GH-130537) Add a note to the `zipfile.Path` class documentation clarifying that it does not sanitize filenames. This emphasizes the caller's responsibility to validate or sanitize inputs, especially when handling untrusted ZIP archives, to prevent path traversal vulnerabilities. The note also references the `extract` and `extractall` methods for comparison and suggests using `os.path.abspath` and `os.path.commonpath` for safe filename resolution. (cherry picked from commit a3990df6121880e8c67824a101bb1316de232898) Co-authored-by: Affan Shaikhsurab <51104750+AffanShaikhsurab@users.noreply.github.com>
* [3.12] Correct function name in `Doc/extending/embedding.rst` (GH-127539) ↵Miss Islington (bot)2025-03-071-2/+2
| | | | | | | | (#130946) Correct function name in `Doc/extending/embedding.rst` (GH-127539) (cherry picked from commit e5527f2cdda501542bf94179093e1a15d7889b74) Co-authored-by: Boris Verkhovskiy <boris.verk@gmail.com>
* [3.12] Update links from typing.readthedocs.io to typing.python.org ↵Miss Islington (bot)2025-03-051-3/+3
| | | | | | | | (GH-130877) (#130884) Update links from typing.readthedocs.io to typing.python.org (GH-130877) (cherry picked from commit 4f6218959e35f649061484cce9de7fc810586533) Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
* [3.12] GH-125722: Increase minimum supported Sphinx to 8.2.0 (GH-130444) ↵Miss Islington (bot)2025-03-051-1/+1
| | | | | | | | (#130859) GH-125722: Increase minimum supported Sphinx to 8.2.0 (GH-130444) (cherry picked from commit e53d105872fafa77507ea33b7ecf0faddd4c3b60) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] gh-129567: Add a note to typing.TypedDict docs about name mangling ↵sobolevn2025-03-041-3/+8
| | | | (GH-130233) (#130842)
* [3.12] Docs: Fix a misplaced statement in the document for `ServerProxy` ↵Miss Islington (bot)2025-03-031-3/+3
| | | | | | | | | | | (GH-130616) (GH-130639) Docs: Fix a misplaced statement in the document for `ServerProxy` (GH-130616) The sentence "If an HTTPS URL ..." explains what the parameter means, so moved it to the paragraph explaining what the other parameters mean. (cherry picked from commit b26286ca49d87ad8491e411f7b0283b0f15ad5be) Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
generated by cgit v0.12 at 2026-01-26 12:26:20 (GMT)