Commit graph

28547 commits

Author SHA1 Message Date
Miss Islington (bot)
56b294e431
[3.13] Fix incorrect indentation in importlib.metadata.rst (GH-126189) (GH-126193)
Fix incorrect indentation in importlib.metadata.rst (GH-126189)
(cherry picked from commit 6f512c6034)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-10-30 11:00:29 -07:00
Miss Islington (bot)
210bd2a50d
[3.13] gh-85583: Add f-string index in tutorial/inputoutput.rst (GH-21681) (GH-126191)
gh-85583: Add f-string index in tutorial/inputoutput.rst  (GH-21681)

* bpo-41411 fstring index in tutorial/inputoutput

To assist in searching for fstrings I have added an index

* Add newline

---------

(cherry picked from commit a3443c0e22)

Co-authored-by: amaajemyfren <32741226+amaajemyfren@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2024-10-30 10:35:10 -07:00
Serhiy Storchaka
6b0ef1fd6f
[3.13] gh-126071: Improve formatting of the argparse documentation (GH-126073) (GH-126173)
* Use appropriate roles for ArgumentParser, Action, etc.
* Remove superfluous repeated links.
* Explicitly document signatures and add index entries for some methods
  and classes.
* Make it more clear that some parameters are keyword-only.
* Fix some minor errors.
(cherry picked from commit 2ab377a47c)
2024-10-30 09:21:38 +00:00
Miss Islington (bot)
de9ff23ea1
[3.13] docs: restore an anchor to for/else (GH-126154) (#126159)
docs: restore an anchor to for/else (GH-126154)
(cherry picked from commit 2d9d10179f)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2024-10-30 08:16:33 +00:00
Miss Islington (bot)
343a7a6259
[3.13] gh-118633: Add warning regarding the unsafe usage of eval and exec (GH-118437) (#126161)
gh-118633: Add warning regarding the unsafe usage of eval and exec (GH-118437)

* Add warning regarding the unsafe usage of eval

* Add warning regarding the unsafe usage of exec

* Move warning under parameters table

* Use suggested shorter text



* Use suggested shorter text



* Improve wording as suggested

---------

(cherry picked from commit 00e5ec0d35)

Co-authored-by: Daniel Ruf <daniel@daniel-ruf.de>
Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-10-30 00:49:18 +00:00
Miss Islington (bot)
f37ac53cd3
[3.13] gh-116938: Fix dict.update docstring and remove erraneous full stop from dict documentation (GH-125421) (#126150)
gh-116938: Fix `dict.update` docstring and remove erraneous full stop from `dict` documentation (GH-125421)
(cherry picked from commit 5527c4051c)

Co-authored-by: Prometheus3375 <35541026+Prometheus3375@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-10-29 23:27:33 +00:00
Miss Islington (bot)
f5b1510e6b
[3.13] Doc: Note that pydoc uses and prefers `MANPAGER` (GH-125362) (#126152)
Doc: Note that pydoc uses and prefers ``MANPAGER`` (GH-125362)
(cherry picked from commit 0e45b1fd0f)

Co-authored-by: Matthieu Ancellin <31126826+mancellin@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-10-29 23:23:18 +00:00
Miss Islington (bot)
5ce23f2703
[3.13] Add lightweight comments to conf.py and update docs readme (GH-126100) (#126134)
Add lightweight comments to conf.py and update docs readme (GH-126100)

* Update contributing contact info in readme

* Add lightweight comments to improve docs workflow understanding

* Apply code review suggestions from @hugovk



* Add code review suggestion from @AA-Turner



* Update Doc/conf.py



* Update Doc/conf.py



* Update Doc/conf.py



---------

(cherry picked from commit 9effa0ff06)

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-10-29 19:21:41 +00:00
Miss Islington (bot)
672b915ff9
[3.13] gh-89762: Document strftime %G, %V, and %u format specifiers (GH-124572) (#126094)
(cherry picked from commit 85799f1ffd)

Co-authored-by: RUANG (James Roy) <longjinyii@outlook.com>
2024-10-28 21:59:41 +00:00
Miss Islington (bot)
ccf040896e
[3.13] gh-120313: amend documentation regarding ctypes._CFuncPtr (GH-120989) (GH-125979)
gh-120313: amend documentation regarding `ctypes._CFuncPtr` (GH-120989)

(cherry picked from commit 417c130ba5)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-10-28 14:20:58 +01:00
Miss Islington (bot)
e4204e879e
[3.13] gh-84545: Clarify the 'extend' action documentation in argparse (GH-125870) (GH-125964)
(cherry picked from commit da8673da36)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-10-26 21:37:06 +03:00
Miss Islington (bot)
f521142b47
[3.13] Fix a typo in `Doc/tutorial/errors.rst` exception output (GH-126001) (#126009)
Fix a typo in ``Doc/tutorial/errors.rst`` exception output (GH-126001)
(cherry picked from commit a78d5b3242)

Co-authored-by: Bogdana Vereha <bogdanap@github.com>
2024-10-26 15:32:37 +00:00
Petr Viktorin
dba992b03b
[3.13] gh-121277: Allow .. versionadded:: next in docs (GH-121278) (#124718)
* gh-121277: Allow `.. versionadded:: next` in docs (GH-121278)

Make `versionchanged:: next`` expand to current (unreleased) version.

When a new CPython release is cut, the release manager will replace
all such occurences of "next" with the just-released version.
(See the issue for release-tools and devguide PRs.)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
(cherry picked from commit 7d24ea9db3)

* gh-121277: Raise nice error on `next` as second argument to deprecated-removed (GH-124623)

(cherry-picked from e349f73a5a)
2024-10-25 15:34:20 +02:00
Miss Islington (bot)
92d301eb67
[3.13] gh-125933: Add ARIA labels to select elements in the version switcher (GH-125934) (#125938)
gh-125933: Add ARIA labels to select elements in the version switcher (GH-125934)
(cherry picked from commit 1306f33c84)

Co-authored-by: Kerim Kabirov <the.privat33r+gh@pm.me>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-10-24 20:57:52 +00:00
Shantanu
3d8b6f0977
[3.13] gh-123930: Better error for "from imports" when script shadows module (GH-123929) (#125937)
gh-123930: Better error for "from imports" when script shadows module (#123929)

(cherry picked from commit 500f5338a8)
2024-10-24 19:37:31 +00:00
Sam Gross
4b55d53316
[3.13] gh-125268: Use static string for "1e309" in AST (GH-125272) (GH-125280)
When formatting the AST as a string, infinite values are replaced by
1e309, which evaluates to infinity. The initialization of this string
replacement was not thread-safe in the free threading build.
(cherry picked from commit 427dcf24de)
2024-10-24 13:59:23 -04:00
Miss Islington (bot)
f27ba61e56
[3.13] gh-125909: Avoid a redirect when linking to the devguide (GH-125826) (#125929)
(cherry picked from commit 5003ad5c5e)

Co-authored-by: partev <petrosyan@gmail.com>
2024-10-24 16:47:01 +00:00
Miss Islington (bot)
22ae72b88f
[3.13] Doc: Show object descriptions in the table of contents (GH-125757) (#125840)
(cherry picked from commit 91ddde4af0)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-10-22 13:13:35 +00:00
Miss Islington (bot)
c1c3f5d19e
[3.13] gh-124969: Make locale.nl_langinfo(locale.ALT_DIGITS) returning a string again (GH-125774) (GH-125804)
This is a follow up of GH-124974. Only Glibc needed a fix.
Now the returned value is a string consisting of semicolon-separated
symbols on all Posix platforms.
(cherry picked from commit dcc4fb2c90)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-10-21 19:30:23 +00:00
Miss Islington (bot)
ace5478673
[3.13] gh-125766: Docs: minor rewording of installation on Linux section (GH-125793)
(cherry picked from commit d67bf2d89a)

Co-authored-by: partev <petrosyan@gmail.com>
2024-10-21 11:56:01 -05:00
Miss Islington (bot)
2e56526412
[3.13] Doc: C API: Move tp_dealloc paragraph to tp_dealloc section (GH-125737) (#125798)
It looks like commit 43cf44ddcc
(gh-31501) accidentally moved the paragraph to the `tp_finalize`
section when the intent was to move it to the `tp_dealloc` section
(according to the commit message).

(cherry picked from commit d880c83ff7)


Co-authored-by: Richard Hansen <rhansen@rhansen.org>
2024-10-21 09:55:36 -07:00
Miss Islington (bot)
7711a1c33f
[3.13] gh-125313: Prefer sys.base_* paths in Py_Get(Exec)Prefix deprecation notes (GH-125317) (#125776)
gh-125313: Prefer `sys.base_*` paths in `Py_Get(Exec)Prefix` deprecation notes (GH-125317)

Prefer `sys.base_*` paths in `Py_Get(Exec)Prefix` deprecation notes.

(cherry picked from commit 7d88140d52)

Signed-off-by: y5c4l3 <y5c4l3@proton.me>
Co-authored-by: Y5 <124019959+y5c4l3@users.noreply.github.com>
2024-10-21 09:41:15 +00:00
Miss Islington (bot)
483c747939
[3.13] Doc: Fix typos (GH-125728) (#125773)
(cherry picked from commit ded105a62b)

Co-authored-by: ember91 <31469580+ember91@users.noreply.github.com>
2024-10-21 08:49:31 +00:00
Miss Islington (bot)
73bd5bd18f
[3.13] gh-99030: Added documentation links for types and exceptions (GH-123857) (#125764)
gh-99030: Added documentation links for types and exceptions (GH-123857)

* Added documentation links for types and exceptions

* Shortened description sentences

* Change content

* Change documentation

* Move seealso

* Add a spaces
(cherry picked from commit 9256be7ff0)

Co-authored-by: RUANG (Roy James) <longjinyii@outlook.com>
2024-10-21 00:42:06 +00:00
Miss Islington (bot)
51659f2e5c
[3.13] Doc: Fix pluralization in os.process_cpu_count() documentation (GH-125678) (#125742)
Co-authored-by: Tom Most <twm@freecog.net>
2024-10-20 00:54:12 +00:00
Miss Islington (bot)
fbbc79ea25
[3.13] GH-125277: Increase minimum supported Sphinx to 7.2.6 (GH-125368) (#125720) 2024-10-19 04:23:22 +00:00
Miss Islington (bot)
253d69feb1
[3.13] gh-95836: Add custom type converter examples to argparse tutorial (GH-125376) (GH-125643)
(cherry picked from commit dbcc5ac470)

Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>
2024-10-17 15:43:08 +03:00
Miss Islington (bot)
ca9bbafb49
[3.13] gh-125615: Fix grammar nit in tutorial's interactive interpreter appendix (GH-125619)
Replace "without ... nor" with "with neither ... nor"

(cherry picked from commit aab3210271)

Authored-by: Cornelius Roemer <cornelius.roemer@gmail.com>
2024-10-16 20:58:49 +00:00
Miss Islington (bot)
cc66dfc86c
[3.13] gh-89819: Add argument_default and conflict_handler to add_argument_group() docs (GH-125379) (GH-125538)
(cherry picked from commit c9826c11db)

Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>
2024-10-15 16:09:50 +00:00
Miss Islington (bot)
4bc59e5fd7
[3.13] Doc: Update CVE URL (GH-125489) (#125503)
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2024-10-15 07:34:15 +00:00
Miss Islington (bot)
624a8e4f97
[3.13] gh-85453: Improve variable mark up for datetime.rst (GH-120702) (#125490)
Variables and literals are marked up using backticks.
(cherry picked from commit 2a5cdb2516)

Co-authored-by: edson duarte <eduarte.uatach@gmail.com>
2024-10-14 22:08:30 +00:00
Miss Islington (bot)
7966c7d69e
[3.13] gh-125461: Remove Python 2 from identifiers in doc (GH-125462) (GH-125464)
gh-125461: Remove Python 2 from identifiers in doc (GH-125462)

Remove Python 2 from identifiers in doc
(cherry picked from commit 5dac0dceda)

Co-authored-by: Paul Hoffman <phoffman@proper.com>
2024-10-14 08:49:35 -07:00
Miss Islington (bot)
6c81928ba7
[3.13] gh-112088: aclocal version is updated to 1.16.5 in docs (GH-125457) (#125459)
gh-112088: aclocal version is updated to 1.16.5 in docs (GH-125457)
(cherry picked from commit 45df264f3f)

Co-authored-by: Mikhail Efimov <efimov.mikhail@gmail.com>
2024-10-14 15:02:06 +00:00
Miss Islington (bot)
1279be610d
[3.13] gh-123133: clarify p=0 case for "f" and "e" formatting types (GH-125426) (#125428)
gh-123133: clarify p=0 case for "f" and "e" formatting types (GH-125426)
(cherry picked from commit cfc27bc50f)

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-10-14 04:50:06 +00:00
Miss Islington (bot)
cff627a27d
[3.13] gh-101291: Add versionadded directives for PyUnstable_Long_* (GH-125384) (#125407)
gh-101291: Add versionadded directives for PyUnstable_Long_* (GH-125384)
(cherry picked from commit c6d7b644c2)

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-10-13 17:44:50 +00:00
Miss Islington (bot)
c9ead96249
[3.13] gh-125383: Update fib function comment for accuracy (GH-125386) (#125395)
gh-125383: Update `fib` function comment for accuracy (GH-125386)

`Doc/tutorial/controlflow.rst`: fix comment for `fib` function
(cherry picked from commit 283ea5f3b2)

Co-authored-by: Wulian <xiguawulian@gmail.com>
2024-10-13 11:16:23 +00:00
Miss Islington (bot)
e47dd93262
[3.13] Doc: Fix suggested usage of -X gil=0 in the glossary (GH-125366) (#125382)
Doc: Fix suggested usage of `-X gil=0` in the glossary (GH-125366)

Currently, the "global interpreter lock" entry in the glossary mentions
that `-X gil 0` can be used to disable the GIL [1]. However, this is
invalid; the correct usage should be `-X gil=0`.

    $ python -X gil 0 -c 'print("Hello, world")'
    Fatal Python error: config_read_gil: PYTHON_GIL / -X gil must be "0" or "1"
    Python runtime state: preinitialized

    $ python -X gil=0 -c 'print("Hello, world")'
    Hello, world

[1]: https://docs.python.org/3/using/cmdline.htmlGH-cmdoption-X

(cherry picked from commit a8fa4ad9e9)

Signed-off-by: Ruoyu Zhong <zhongruoyu@outlook.com>
Co-authored-by: Ruoyu Zhong <zhongruoyu@outlook.com>
2024-10-13 00:59:05 +00:00
Miss Islington (bot)
6afdb09859
[3.13] gh-125289: Update sample code in asyncio-task.rst (GH-125292) (GH-125374)
gh-125289: Update sample code in asyncio-task.rst (GH-125292)

* Update sample code in asyncio-task.rst

This will change **coroutines** sample code in the **Awaitables** section and make the example clearer.

* Update Doc/library/asyncio-task.rst

Revert the added print



* Update Doc/library/asyncio-task.rst



---------

(cherry picked from commit fa52b82c91)

Co-authored-by: Ghorban M. Tavakoly <58617996+galmyk@users.noreply.github.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2024-10-12 20:43:30 +00:00
Miss Islington (bot)
0542645354
[3.13] gh-85935: Explicitly document the case nargs=0 in argparse (GH-125302) (GH-125357)
(cherry picked from commit 07c2d15977)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-10-12 16:02:26 +03:00
Miss Islington (bot)
a314026cfe
[3.13] Doc: Fix a typo in "Function Examples" in the control-flow tutorial (GH-125338) (#125341)
Doc: Fix a typo in "Function Examples" in the control-flow tutorial (GH-125338)
(cherry picked from commit 5a074aab84)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-10-12 00:45:50 +00:00
Miss Islington (bot)
21764ec5ab
[3.13] gh-116938: Clarify documentation of dict and dict.update regarding the positional argument they accept (GH-125213) (#125336)
Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-10-11 23:29:01 +00:00
Miss Islington (bot)
488807a52a
[3.13] Fix typo in `Doc/library/functions.rst` (GH-125327) (#125333)
Fix typo in ``Doclibrary/functions.rst`` (GH-125327)
(cherry picked from commit 76b29d271b)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-10-11 20:06:19 +00:00
Miss Islington (bot)
73c152b346
[3.13] Add some doctest cleanups for configparser (GH-125288) (#125290)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-10-11 09:48:32 +00:00
Miss Islington (bot)
49f171d9ea
[3.13] gh-125058: update _thread docs regarding interruptibility of lock.acquire() (GH-125141) (#125306)
gh-125058: update `_thread` docs regarding interruptibility of `lock.acquire()` (GH-125141)
(cherry picked from commit 0135848059)

Co-authored-by: Jan Kaliszewski <zuo@kaliszewski.net>
2024-10-11 08:20:46 +00:00
Miss Islington (bot)
1fe27103e0
[3.13] gh-125296: Fix strange fragment identifier for name or flags in argparse docs (GH-125297) (#125299)
gh-125296: Fix strange fragment identifier for `name or flags` in argparse docs (GH-125297)
(cherry picked from commit c1913effee)

Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>
2024-10-11 06:35:49 +00:00
Serhiy Storchaka
26a93189e4
[3.13] gh-124969: Fix locale.nl_langinfo(locale.ALT_DIGITS) (GH-124974) (#125232)
Returns a tuple of up to 100 strings for ALT_DIGITS lookup (an empty tuple on most locales).
Previously it returned the first item of that tuple or an empty string.
(cherry picked from commit 21c04e1a97)
2024-10-11 05:56:22 +08:00
Miss Islington (bot)
2019362d95
[3.13] Doc: Upgrade Sphinx to 8.1 (GH-125276) (#125278)
Doc: Upgrade Sphinx to 8.1 (GH-125276)
(cherry picked from commit dd0ee201da)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-10-10 20:31:40 +00:00
Miss Islington (bot)
319305c0bf
[3.13] Note argparse exit code in documentation (GH-119568) (GH-125274)
(cherry picked from commit 3b87fb74c9)

Co-authored-by: Justin Kunimune <justinkunimune@gmail.com>
Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>
2024-10-10 21:18:17 +03:00
Miss Islington (bot)
47ad32d158
[3.13] gh-71784: [doc] add usage examples for traceback.TracebackException (GH-125189) (#125247)
Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-10-10 10:46:31 +00:00
Adam Turner
abb01fd938
[3.13] GH-121970: Extract `availability` into a new extension (GH-125082) (#125237)
(cherry picked from commit cbfd392479)
2024-10-10 10:43:43 +00:00