summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* [3.12] Clarify that dklen is expected in bytes for the hashlib functions ↵Miss Islington (bot)2024-05-221-2/+2
| | | | | | | (GH-106624) (GH-119384) (cherry picked from commit 5adf78f546a5dc3f5b8eeaa209a2e8437ae96ac8) Co-authored-by: Mathijs Mortimer <thiezn@users.noreply.github.com>
* [3.12] gh-110383: Align dict.get(), .fromkeys(), and .setdefault() docs with ↵Miss Islington (bot)2024-05-221-3/+3
| | | | | | | docstrings (GH-119330) (#119371) (cherry picked from commit 0e3c8cda1f04c983994e76aea93600dbb4714832) Co-authored-by: Landon Wood <landon@elkrange.com>
* [3.12] gh-110383: Document `socket.makefile()` accepts combined modes ↵Miss Islington (bot)2024-05-211-1/+2
| | | | | | | | (GH-119150) (#119325) The supported mode values are 'r', 'w', and 'b', or a combination of those. (cherry picked from commit 62a29be5bb01c2d0f72d8f9b1b5539816e65310c) Co-authored-by: Daniel Williams <dann0a@gmail.com>
* [3.12] GH-110383: Improve Tutorial for Input Ouput (GH-119230) (GH-119327)Miss Islington (bot)2024-05-211-4/+16
| | | | | | | | GH-110383: Improve Tutorial for Input Ouput (GH-119230) (cherry picked from commit 9db2fd7edaa9d03e8c649c3bb0e8d963233cde22) Co-authored-by: Blaise Pabon <blaise@gmail.com> Co-authored-by: edson duarte <eduarte.uatach@gmail.com>
* [3.12] Docs: Ensure no warnings are found in the NEWS file before a given ↵Hugo van Kemenade2024-05-211-0/+40
| | | | line number (GH-119221) (#119266)
* [3.12] gh-118912: Remove description of issue fixed in 3.5 from autospeccing ↵Miss Islington (bot)2024-05-201-32/+8
| | | | | | | | | | | | | | | | | | guide (GH-119232) (#119283) gh-118912: Remove description of issue fixed in 3.5 from autospeccing guide (GH-119232) * Remove description of issue fixed in 3.5 from autospeccing guide * Make autospeccing note text more succint and lint whitespace * Add linting changes (missed in last commit) --------- (cherry picked from commit 7e57640c7ec6b7b5ce9b5eac465f6b771fd6ae69) Co-authored-by: Shauna <shaunagm@gmail.com> Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
* [3.12] gh-108267 Fix another dataclasses docs typo (GH-119277) (#119280)Miss Islington (bot)2024-05-201-1/+2
| | | | | | gh-108267 Fix another dataclasses docs typo (GH-119277) (cherry picked from commit 423bbcbbc43cacfb6a217c04f890a47d3cf7c3a9) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] Use correct markup in unittest.mock.reset_mock documentation ↵Miss Islington (bot)2024-05-201-3/+3
| | | | | | | | (GH-119207) (GH-119249) Use correct markup in unittest.mock.reset_mock documentation (GH-119207) (cherry picked from commit 6b80a5b20f31a067bd1c374295608df5f1210f49) Co-authored-by: Tialo <65392801+Tialo@users.noreply.github.com>
* [3.12] DOCS: Suggest always calling exec with a globals argument and no ↵Miss Islington (bot)2024-05-201-3/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | locals argument (GH-119235) (#119240) DOCS: Suggest always calling exec with a globals argument and no locals argument (GH-119235) Many users think they want a locals argument for various reasons but they do not understand that it makes code be treated as a class definition. They do not want their code treated as a class definition and get surprised. The reason not to pass locals specifically is that the following code raises a `NameError`: ```py exec(""" def f(): print("hi") f() def g(): f() g() """, {}, {}) ``` The reason not to leave out globals is as follows: ```py def t(): exec(""" def f(): print("hi") f() def g(): f() g() """) ``` (cherry picked from commit 7e1a130b8ff1ed8b3a5f00fe0f06d3916b852216) Co-authored-by: Hood Chatham <roberthoodchatham@gmail.com>
* [3.12] marshal docs: Remove reference to "Sun" (GH-119161) (#119168)Miss Islington (bot)2024-05-191-1/+1
| | | | | | | | Nobody has been using a Sun machine for a long time. When I saw this sentence in a lightning talk just now, I thought it was talking about sending Python code on a spacecraft. (cherry picked from commit 697465ff88e49d98443025474e5b534adfba2cb0) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* [3.12] gh-119078: Clarify venv tutorial (GH-119129) (GH-119141)Miss Islington (bot)2024-05-181-4/+4
| | | (cherry picked from commit 0f5e8bed636c2f29701e5a1965d1b088d33abbf0)
* [3.12] Minor improvements to the docs for itertools.tee() (gh-119135) ↵Miss Islington (bot)2024-05-181-10/+11
| | | | (gh-119137)
* [3.12] gh-108267: Fix object.__setattr__ regression in dataclasses docs ↵Miss Islington (bot)2024-05-161-1/+2
| | | | | | (GH-119082) (#119098) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* [3.12] gh-119009: Add gettext target (GH-119006) (#119075)Miss Islington (bot)2024-05-152-0/+8
| | | | Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
* [3.12] Misc improvements to the itertools docs (gh-119040) (#119044)Miss Islington (bot)2024-05-141-35/+26
|
* [3.12] Itertools docs: fix parameter names and indentation in Python ↵Miss Islington (bot)2024-05-141-5/+5
| | | | equivalents (gh-118977) (#119042)
* [3.12] gh-119010: Adds docs about `__type_params__` to ↵Miss Islington (bot)2024-05-131-2/+6
| | | | | | | | | `functools.update_wrapper` (GH-119012) (#119014) gh-119010: Adds docs about `__type_params__` to `functools.update_wrapper` (GH-119012) (cherry picked from commit b04c497f187b0b474e431a6d8d282269b40ffe52) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* [3.12] Improve the `rmtree` doc for `dir_fd` param addition in 3.11 ↵Miss Islington (bot)2024-05-131-1/+1
| | | | | | (GH-118964) (#118992) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.12] GH-118701: Note that recursive wildcards aren't supported in ↵Barney Gale2024-05-111-0/+4
| | | | `PurePath.match()` (#118713)
* [3.12] Correct the argument names for `secrets.choice` and ↵Miss Islington (bot)2024-05-101-3/+3
| | | | | | | | | | `secrets.randbelow` in `secrets.rst` (GH-118098) (GH-118907) Correct the argument names for `secrets.choice` and `secrets.randbelow` in `secrets.rst` (GH-118098) Correct the argument names for `secrets.choice` and `secrets.randbelow` in `secrets.rst`. (cherry picked from commit c444362c6e0b6c01f49c3bee864100f52bd3b640) Co-authored-by: Adam Dangoor <adamdangoor@gmail.com>
* gh-118689: Doc: fix ePub build (GH-118690)Miss Islington (bot)2024-05-103-1/+7
| | | | | (cherry picked from commit 7ac933e2609b2ef9b08ccf9c815b682b0e1ede2a) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* gh-118486: Support mkdir(mode=0o700) on Windows (GH-118488)Steve Dower2024-05-092-0/+18
|
* [3.12] Format None, True, False and NotImplemented as literals (GH-118758) ↵Serhiy Storchaka2024-05-0826-58/+58
| | | | | (GH-118794) (cherry picked from commit 05c2fe1acda9ea5a57061642c36e8b73bb4fbba4)
* [3.12] docs: module page titles should not start with a link to themselves ↵Miss Islington (bot)2024-05-08220-443/+440
| | | | | | | | (GH-117099) (#118791) docs: module page titles should not start with a link to themselves (GH-117099) (cherry picked from commit bcb435ee8ff41b5ec5d879ee0b6651f146a66151) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* [3.12] Docs: fix typos in documentation (GH-118752) (#118786)Miss Islington (bot)2024-05-084-4/+4
| | | | | | Docs: fix typos in documentation (GH-118752) (cherry picked from commit 7b0c247f1c176e092777fce4677a00f22c738b3c) Co-authored-by: Xie Yanbo <xieyanbo@gmail.com>
* [3.12] gh-118671: Updated dead ActiveState links (GH-118730) (#118754)Miss Islington (bot)2024-05-089-10/+10
| | | | | | Co-authored-by: trag1c <trag1cdev@yahoo.com> Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
* [3.12] Regen ``Doc/requirements-oldest-sphinx.txt`` (GH-118736) (#118753)Miss Islington (bot)2024-05-081-3/+3
| | | | | | | | Regen ``Doc/requirements-oldest-sphinx.txt`` (GH-118736) Regen dependencies (cherry picked from commit fcf52d7ceea3532f0b3475aadd4e1f72db463a1f) Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
* [3.12] Remove Python 3.5 hardcoded version in the tutorial appendix ↵Miss Islington (bot)2024-05-071-2/+2
| | | | | | | | (GH-117612) (GH-118707) Remove Python 3.5 hardcoded version in the tutorial appendix (GH-117612) (cherry picked from commit a855f824a2f5a310ffa58a973a8fe9feaa2500b3) Co-authored-by: Kerim Kabirov <the.privat33r+gh@pm.me>
* [3.12] gh-118310: Fix documentation for `enum.Enum.__new__` (GH-118311) ↵Miss Islington (bot)2024-05-071-5/+7
| | | | | | | | | | | | | (GH-118699) gh-118310: Fix documentation for `enum.Enum.__new__` (GH-118311) The provided example was incorrect: - The example enum was missing the `int` mixin as implied by the context - The value of `int('1a', 16)` was incorrectly given as 17 (should be 26) (cherry picked from commit 48e52fe2c9a7b33671f6b5d1420a71a6f31ad64b) Co-authored-by: Momo Eissenhauer <mmEissen@users.noreply.github.com>
* [3.12] gh-78612: Mark up eval() using param list (GH-115212) (#116044)Miss Islington (bot)2024-05-071-5/+15
| | | | | | Also mention that the 'expression' parameter can be a string. (cherry picked from commit a71e32ce8e183023fc1ee401c22ebe35e4832f09) Co-authored-by: Erlend E. Aasland <erlend@python.org>
* [3.12] Expand recipe for kernel density estimation to include common tasks. ↵Raymond Hettinger2024-05-061-10/+46
| | | | (gh-118659)
* [3.12] Fix typo in Doc/library/asyncio-task.rst (GH-118627) (#118657)Miss Islington (bot)2024-05-061-1/+1
| | | | | | Fix typo in Doc/library/asyncio-task.rst (GH-118627) (cherry picked from commit fc50f1bdbad3aa52d7cbd3cb836a35806266ec54) Co-authored-by: Xie Yanbo <xieyanbo@gmail.com>
* [3.12] GH-115577 Clarify netloc term usage in urllib.parse docs (GH-117632) ↵Miss Islington (bot)2024-05-061-0/+5
| | | | | | | (GH-118656) (cherry picked from commit 3ed3bc379a0c4ce7a107dd4bc276554fbb477998) Co-authored-by: Kerim Kabirov <the.privat33r+gh@pm.me>
* [3.12] gh-118476: Fix corner cases in islice() rough equivalent. (Gh-118559) ↵Miss Islington (bot)2024-05-051-18/+11
| | | | (#118587)
* [3.12] Minor improvements to the itertools recipes (GH-118563) (#118565)Miss Islington (bot)2024-05-031-24/+12
|
* [3.12] docs: clarify csv.DictReader's treatment of the first data row ↵Miss Islington (bot)2024-05-031-2/+4
| | | | | | | | (GH-118549) (#118555) (cherry picked from commit 9d67b72a4952766fdba803eb6eadd41dfee29dff) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* [3.12] gh-117492: Clarify documentation of `typing.Never` (GH-117678) (#118547)Miss Islington (bot)2024-05-031-24/+22
| | | | | | | (cherry picked from commit 852263e1086748492602a90347ecc0a3925e1dda) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
* [3.12] gh-117903: Clarify that the staticmethod descriptor is callable ↵Miss Islington (bot)2024-05-021-2/+3
| | | | | | | (GH-117925) (GH-118509) (cherry picked from commit b3372481b6cae5766330b041c4622c28cee2119f) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.12] docs: typo: tiny grammar change: "pointed by" -> "pointed to by" ↵Jelle Zijlstra2024-05-022-4/+4
| | | | | | | | (GH-118411) (#118504) (cherry picked from commit a6b610a94bee0e4436aee2825c14f05ec2f22f75) Co-authored-by: Andrew Zipperer <47086307+zipperer@users.noreply.github.com> Co-authored-by: Andrew-Zipperer <atzipperer@gmail.com>
* [3.12] gh-85453: Consistent backquotes on None occurences across ↵Miss Islington (bot)2024-04-301-1/+1
| | | | | | | datetime.rst (GH-118282) (#118419) (cherry picked from commit 0f797402bc77192c76a952410ca8e17359feab3c) Co-authored-by: edson duarte <eduarte.uatach@gmail.com>
* [3.12] gh-118359: Improve docs for Bdb.user_call (GH-118368) (#118410)Miss Islington (bot)2024-04-291-0/+3
| | | | | | | | gh-118359: Improve docs for Bdb.user_call (GH-118368) The `argument_list` parameter of bdb.Bdb.user_call has been useless for 25 years. It is retained for backwards compatibility, but it will always be None. (cherry picked from commit 8e4fb5d260e529c9d4ca60980225fbd00dd5c3c8) Co-authored-by: Tian Gao <gaogaotiantian@hotmail.com>
* [3.12] Docs: Upgrade to Sphinx 7.3 (GH-118397) (#118400)Miss Islington (bot)2024-04-291-1/+1
| | | | Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.12] gh-101100: Fix Sphinx warnings in `library/faulthandler.rst` ↵Miss Islington (bot)2024-04-282-8/+9
| | | | | | (GH-118353) (#118366) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.12] gh-101100: Fix Sphinx warnings in `whatsnew/3.10.rst` (GH-118356) ↵Miss Islington (bot)2024-04-281-37/+37
| | | | | | (#118367) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.12] gh-101100: Fix Sphinx warnings in `whatsnew/3.9.rst` (GH-118364) ↵Hugo van Kemenade2024-04-282-27/+27
| | | | (#118365)
* [3.12] Fix note in Enum.__new__ docs (GH-118284) (#118325)Jelle Zijlstra2024-04-261-5/+5
| | | | | (cherry picked from commit 5a4d3df2fa02409ffd2a90cd75b67370206e9891) Co-authored-by: Philipp A <flying-sheep@web.de>
* [3.12] gh-117928: Bump the minimum Sphinx version to 6.2.1 (GH-117853) (#118321)Kirill Podoprigora2024-04-264-39/+22
| | | | Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.12] gh-118235: Skip RAISE_SYNTAX_ERROR rules in the grammar spec ↵Miss Islington (bot)2024-04-261-0/+2
| | | | | | | | (GH-118237) (GH-118309) gh-118235: Skip RAISE_SYNTAX_ERROR rules in the grammar spec (GH-118237) (cherry picked from commit ef940dec409f0a9e4f353c6188990aeb3ad4ffb4) Co-authored-by: Petr Viktorin <encukou@gmail.com>
* [3.12] gh-85453: Make numeric literals consistent across datetime.rst ↵Miss Islington (bot)2024-04-241-3/+3
| | | | | | | | (GH-118245) (#118248) Remove code formatting from remaining numeric literals. (cherry picked from commit 59a4d52973ca73bd739f914e88243a31dbef6b32) Co-authored-by: edson duarte <eduarte.uatach@gmail.com>
* [3.12] gh-85453: Adapt datetime.rst to devguide recommendations for code ↵Miss Islington (bot)2024-04-241-45/+45
| | | | | | | | | | | | snippets and variables (GH-118068) (#118244) Also remove formatting from numeric literals. (cherry picked from commit 809aa9a682fc865f7502e7421da0a74d204aab6d) Co-authored-by: edson duarte <eduarte.uatach@gmail.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Erlend E. Aasland <erlend@python.org>