summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* gh-103109: Document ignore_warnings() test support helper (GH-103110)Miss Islington (bot)2023-04-021-0/+15
| | | | | | (cherry picked from commit 32937d6aa414ec7db5c63ef277f21db1880b3af4) Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* Minor docs improvements fix for `codeop` (GH-103123)Miss Islington (bot)2023-03-301-7/+7
| | | | | (cherry picked from commit c1e71ce56fdb3eab62ad3190d09130f800e54610) Co-authored-by: gaogaotiantian <gaogaotiantian@hotmail.com>
* gh-103099: Link mypy docs from typing.rst (GH-103100)Miss Islington (bot)2023-03-301-0/+8
| | | | | (cherry picked from commit fda95aa19447fe444ac2670afbf98ec42aca0c6f) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* [3.10] gh-102582: Fix invalid JSON in Doc/howto/logging-cookbook.rst ↵Miss Islington (bot)2023-03-291-10/+14
| | | | | | (GH-102635) (GH-103107) (cherry picked from commit d835b3f05de7e2d800138e5969eeb9656b0ed860) Co-authored-by: Matěj Cepl <mcepl@cepl.eu>
* Update pdb docs for arguments (GH-102965)Miss Islington (bot)2023-03-251-21/+21
| | | | | (cherry picked from commit 027223db96b0464c49a74513f82a1bf25aa510bd) Co-authored-by: gaogaotiantian <gaogaotiantian@hotmail.com>
* [3.10] gh-103025: fix a ctypes doc typo (GH-103026) (#103030)Miss Islington (bot)2023-03-251-2/+2
| | | | * gh-103025: fix two ctypes doc issues (GH-103026) (cherry picked from commit 0708437ad043657f992cb985fd5c37e1ac052f93)
* [3.10] gh-101100: Document PyObject_ClearWeakRefs and gzip's name (#103002)Hugo van Kemenade2023-03-252-0/+16
|
* gh-102873: logging.LogRecord docs: improve description of `msg` parameter ↵Miss Islington (bot)2023-03-241-2/+3
| | | | | | | | (GH-102875) (cherry picked from commit f2e5a6ee628502d307a97f587788d7022a200229) Co-authored-by: Amin Alaee <mohammadamin.alaee@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.10] gh-96931: Fix incorrect results in ssl.SSLSocket.shared_ciphers ↵Miss Islington (bot)2023-03-241-1/+1
| | | | | | | | (GH-96932) (#102919) gh-96931: Fix incorrect results in ssl.SSLSocket.shared_ciphers (GH-96932) (cherry picked from commit af9c34f6ef8dceb21871206eb3e4d350f6e3d3dc) Co-authored-by: Benjamin Fogle <benfogle@gmail.com>
* gh-98239: Document that `inspect.getsource()` can raise `TypeError` (GH-101689)Miss Islington (bot)2023-03-231-0/+4
| | | | | (cherry picked from commit b6132085ca5418f714eff6e31d1d03369d3fd1d9) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* gh-102936: typing: document performance pitfalls of protocols decorated with ↵Miss Islington (bot)2023-03-231-2/+18
| | | | | | | `@runtime_checkable` (GH-102937) (cherry picked from commit 58d2b30c012c3a9fe5ab747ae47c96af09e0fd15) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* Docs: improve accuracy of sqlite3.Connection.interrupt() (GH-102904)Miss Islington (bot)2023-03-221-1/+1
| | | | | | (cherry picked from commit 7b2d53daccf5a6479e179535068fd9a841db44fc) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* Docs: improve the accuracy of the sqlite3.connect() timeout param (GH-102900)Miss Islington (bot)2023-03-221-3/+3
| | | | | | (cherry picked from commit c24f1f1e874c283bb11d8b9fbd661536ade19fe9) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* Docs: improve accuracy of pdb alias example (GH-102892)Miss Islington (bot)2023-03-221-1/+1
| | | | | (cherry picked from commit e0c63b72671bf816d3073f1a6a9107f6c171cae7) Co-authored-by: gaogaotiantian <gaogaotiantian@hotmail.com>
* gh-102595: Document `PyObject_Format` c-api function (GH-102596)Miss Islington (bot)2023-03-221-0/+9
| | | | | | (cherry picked from commit 910a64e3013bce821bfac75377cbe88bedf265de) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Def: https://github.com/python/cpython/blame/5ffdaf748d98da6065158534720f1996a45a0072/Include/abstract.hGH-L389
* Add link to `sys.exit` function documentation (GH-102805)Miss Islington (bot)2023-03-211-1/+1
| | | | | | | | | | | | | | | | | | | * Add link to `sys.exit` function documentation * Update Doc/library/os.rst Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> * Update Doc/library/os.rst Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> --------- (cherry picked from commit 41ef502d740b96ca6333a2d0202df7cce4a84e7d) Co-authored-by: David Poirier <1152277+david-poirier@users.noreply.github.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* [3.10] Fix outdated note about 'int' rounding or truncating (GH-102736) ↵Miss Islington (bot)2023-03-161-4/+3
| | | | | | | | (#102767) Fix outdated note about 'int' rounding or truncating (GH-102736) (cherry picked from commit 405739f9166592104a5b0b945de92e28415ae972) Co-authored-by: Mark Dickinson <dickinsm@gmail.com>
* gh-101100: Documenting --prefix and --exec-prefix. (GH-102695)Miss Islington (bot)2023-03-155-8/+24
| | | | | | (cherry picked from commit 61b9ff35cbda0cc59816951a17de073968fc25c6) Co-authored-by: Julien Palard <julien@palard.fr> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
* [3.10] Remove misformatted exclamation marks in docs (GH-102694) (#102717)Hugo van Kemenade2023-03-151-2/+2
| | | | | | | | | | | | | | | | | | | Remove the exclamation mark from :program:`!foo` in .rst files because it inadvertently shows up in the rendered HTML. (Sphinx's cross-referencing roles use a '!' prefix to suppress hyperlinking[1], but :program: is not a cross-referencing role so the '!' is displayed verbatim.) The exclamation marks in venv.rst were introduced in #98350. See comments [2] and [3] for additional discussion. [1]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#cross-referencing-syntax [2]: https://github.com/python/cpython/pull/98350#issuecomment-1285965759 [3]: https://github.com/python/cpython/pull/98350#issuecomment-1286394047 Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk> Co-authored-by: Tom Levy <tomlevy93@gmail.com>
* gh-102703: Fix typo in modules tutorial documentation (GH-102707)Miss Islington (bot)2023-03-151-1/+1
| | | | | | | | | **Before** This prevents directories with a common name, such as ``string``, unintentionally hiding ... **After** This prevents directories with a common name, such as ``string``, from unintentionally hiding ... (cherry picked from commit 0a539b5db312d126ff45dd4aa6a53d40a292c512) Co-authored-by: Robert Prater (B. Eng) <robcprater@gmail.com>
* [3.10] gh-102354: change python3 to python in docs examples (GH-102696) ↵Miss Islington (bot)2023-03-145-6/+6
| | | | | | | | (#102698) gh-102354: change python3 to python in docs examples (GH-102696) (cherry picked from commit 80abd62647b2a36947a11a6a8e395061be6f0c61) Co-authored-by: Paul Watson <paul.hermeneutic@gmail.com>
* gh-100315: clarification to `__slots__` docs. (GH-102621)Miss Islington (bot)2023-03-141-2/+4
| | | | | | refer to tp_itemsize in discussion on "variable-length" built-in types (cherry picked from commit 88c262c086077377b40dfae5e46f597e28ffe3c9) Co-authored-by: T <tnie@tuta.io>
* doc: Remove a duplicate 'versionchanged' in library/asyncio-task (gh-102677)Miss Islington (bot)2023-03-141-3/+0
| | | | | (cherry picked from commit 7bdb331b67c4aee513e01794ba7dd2c3be43d3ca) Co-authored-by: Joongi Kim <me@daybreaker.info>
* gh-102627: Replace address pointing toward malicious web page (GH-102630)Miss Islington (bot)2023-03-131-1/+1
| | | | | | | | | * Replace known bad address pointing toward a malicious web page. (cherry picked from commit 61479d46848bc7a7f9b571b0b09c4a4b4436d839) Co-authored-by: Blind4Basics <32236948+Blind4Basics@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.10] Fix duplicated words in the docs (#102645)Alex Waygood2023-03-132-2/+2
| | | | | | | (cherry-picked from commit f6ca71a) With grep utility found some duplicated words Co-authored-by: Виталий Дмитриев <vitaldmit@bk.ru>
* gh-101100: Fix Sphinx warnings in `turtle` module (GH-102340)Miss Islington (bot)2023-03-131-27/+31
| | | | | | (cherry picked from commit 78e4e6c3d71980d4e6687f07afa6ddfc83e29b04) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* gh-101100: Fix sphinx warnings in `zipapp` and `zipfile` modules (GH-102526)Miss Islington (bot)2023-03-082-2/+2
| | | | | (cherry picked from commit 1f557f94c2ee98c2a43bd090a7bf3f39a22ed874) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* Add gettext support to tools/extensions/c_annotations.py (GH-101989)Miss Islington (bot)2023-03-062-3/+9
| | | | | (cherry picked from commit d959bcd4a0393a120fa12c034de4041037d171c3) Co-authored-by: Rémi Lapeyre <remi.lapeyre@lenstra.fr>
* gh-101754: Document that Windows converts keys in `os.environ` to uppercase ↵Miss Islington (bot)2023-03-031-0/+5
| | | | | | | (GH-101840) (cherry picked from commit 4e7c0cbf59595714848cf9827f6e5b40c3985924) Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
* [3.10] Fix typos in documentation and comments (GH-102374) (#102377)Alex Waygood2023-03-021-1/+1
| | | | | | | | | | | Fix typos in documentation and comments (GH-102374) Found some duplicate `to`s in the documentation and some code comments and fixed them. [Misc/NEWS.d/3.12.0a1.rst](https://github.com/python/cpython/blob/ed55c69ebd74178115cd8b080f7f8e7588cd5fda/Misc/NEWS.d/3.12.0a1.rst) also contains two duplicate `to`s, but I wasn't sure if it's ok to touch that file. Looks auto generated. I'm happy to amend the PR if requested. :) Automerge-Triggered-By: GH:AlexWaygood Co-authored-by: Michael K <michael-k@users.noreply.github.com>
* [3.10] gh-90744: Fix erroneous doc links in the sys module (GH-101319) (#102322)Hugo van Kemenade2023-03-021-43/+49
| | | | | | | Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Brad Wolfe <brad.wolfe@gmail.com> Co-authored-by: Furkan Onder <furkanonder@protonmail.com> Fix erroneous doc links in the sys module (#101319)
* gh-102296 Document that inspect.Parameter kinds support ordering (GH-102297)Miss Islington (bot)2023-02-271-2/+3
| | | | | | (cherry picked from commit 0db6f442598a1994c37f24e704892a2bb71a0a1b) Co-authored-by: Gouvernathor <44340603+Gouvernathor@users.noreply.github.com> Automerge-Triggered-By: GH:AlexWaygood
* gh-101100: Fix sphinx warnings in `types` module (GH-102274)Miss Islington (bot)2023-02-271-1/+1
| | | | | | (cherry picked from commit 101a12c5767a8c6ca6e32b8e24a462d2606d24ca) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.10] [doc] Improve grammar/fix missing word (GH-102060) (GH-102278)Miss Islington (bot)2023-02-262-2/+2
| | | | | | [doc] Improve grammar/fix missing word (GH-102060) (cherry picked from commit 6daf42b28e1c6d5f0c1a6350cfcc382789e11293) Co-authored-by: VMan <vayidm@users.noreply.github.com>
* [3.10] gh-85417: Clarify behaviour on branch cuts in cmath module ↵Miss Islington (bot)2023-02-261-28/+38
| | | | | | | | | | | | | (GH-102046) (#102275) gh-85417: Clarify behaviour on branch cuts in cmath module (GH-102046) This PR updates the cmath module documentation to reflect the reality that Python is almost always (and as far as I can tell, that "almost" can be omitted) running on a machine whose C double supports signed zeros. * Removes misleading references to functions being continuous from above / below / the left / the right at branch cuts * Expands the note on branch cuts at the top of the module documentation to explain the double-sided sign-of-zero-based behaviour (cherry picked from commit b513c46d998344dc07eb6d510782c2e23d2b859e) Co-authored-by: Mark Dickinson <dickinsm@gmail.com>
* gh-102259: Fix re doc issue regarding right square brackets (GH-102264)Miss Islington (bot)2023-02-261-1/+2
| | | | | | (cherry picked from commit bcadcde7122f6d3d08b35671d67e105149371a2f) Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* [3.10] GH-99818: improve the documentation for zipfile.Path and Traversable ↵Shantanu2023-02-252-3/+7
| | | | (GH-101589) (#102267)
* gh-101100: Fix sphinx warnings in `typing` module docs (GH-102260)Miss Islington (bot)2023-02-251-1/+1
| | | | | (cherry picked from commit a498de4c0ef9e264cab3320afbc4d38df6394800) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* asyncio docs: Fix dangling hyphen (GH-102227)Miss Islington (bot)2023-02-251-2/+2
| | | | | | Currently this gets rendered with a dangling hyphen. (cherry picked from commit 207e1c5cae11108213dff5ff07443ee4cfa0d2ea) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* gh-101100: Fix Sphinx warnings in `decimal` module (GH-102125)Miss Islington (bot)2023-02-251-84/+84
| | | | | | (cherry picked from commit b7c11264476ccc11e4bdf4bd3c3664ccd1b7c5f9) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* Fix typo in `Py_GetPythonHome` signature (GH-102168)Miss Islington (bot)2023-02-231-1/+1
| | | | | (cherry picked from commit 9bba8035bd99813203cb3b0de218f9cc3bcdaf2f) Co-authored-by: Tanner Firl <105078804+TannerFirl@users.noreply.github.com>
* Fix syntax error in struct doc example (GH-102160)Miss Islington (bot)2023-02-231-1/+1
| | | | | | Missing closing ) reported on Discuss by Chukwudi Nwachukwu. (cherry picked from commit 8f647477f0ab5362741d261701b5bcd76bd69ec1) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* GH-101777: `queue.rst`: use 2 spaces after a period to be consistent. ↵Miss Islington (bot)2023-02-221-8/+8
| | | | | | | (GH-102143) (cherry picked from commit 96bf24380e44dfa1516d65480250995e737c0cb9) Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
* [3.10] gh-102135: Update turtle docs to rename wikipedia demo to rosette ↵Miss Islington (bot)2023-02-221-3/+3
| | | | | | (GH-102137) (#102139) Co-authored-by: somebody <98094921+UndoneStudios@users.noreply.github.com>
* gh-100556: Improve clarity of `or` docs (GH-100589)Miss Islington (bot)2023-02-211-2/+2
| | | | | | (cherry picked from commit b40dd71241f092d90c192ebff5d58cbd7e84dc52) Co-authored-by: ram vikram singh <ramvikrams243@gmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* gh-101777: Make `PriorityQueue` docs slightly clearer (GH-102026)Miss Islington (bot)2023-02-211-2/+2
| | | | | | | Adjust wording slightly, and use min(entries) instead of sorted(list(entries))[0] as an example. (cherry picked from commit 350ba7c07f8983537883e093c5c623287a2a22e5) Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
* gh-99735: Use required=True in argparse subparsers example (GH-100927)Miss Islington (bot)2023-02-191-1/+1
| | | | | (cherry picked from commit 6aab56f3c2ee331116eba242d2fcdca592577328) Co-authored-by: Patricio Paez <nospam@pp.com.mx>
* Fix incorrectly documented attribute in csv docs (GH-101250)Miss Islington (bot)2023-02-191-1/+1
| | | | | (cherry picked from commit 36b670908b3546f46283aae4dbf311e53289f3d1) Co-authored-by: Reza Rastak <rezarastak@users.noreply.github.com>
* [3.10] gh-85747: Active voice & suggested edits, 'running/stopping loop' & ↵Brian Skinn2023-02-181-13/+17
| | | | | | | | | | | 'callbacks' subsections of asyncio-eventloop.rst (gh-100270) (#102005) Note: The `timeout` parameter was not added until Python 3.12. (cherry picked from commit c4de6b1d52304a0a9cdfafc1dad5098993710404) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* gh-100226: Clarify StreamReader.read behavior (GH-101807)Miss Islington (bot)2023-02-171-2/+10
| | | | | (cherry picked from commit 77d95c83733722ada35eb1ef89ae5b84a51ddd32) Co-authored-by: Jan Gosmann <jan@hyper-world.de>
generated by cgit v0.12 at 2025-01-31 12:24:20 (GMT)