Commit graph

28001 commits

Author SHA1 Message Date
Miss Islington (bot)
720de0dc63
[3.12] gh-122876: Fix "End of lines" typo (GH-125310) (#130316)
Co-authored-by: za <za@python.or.id>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-02-19 19:24:21 +00:00
Miss Islington (bot)
43898abd9a
[3.12] Docs: Upgrade Sphinx to 8.2 (GH-130171) (#130288)
Docs: Upgrade Sphinx to 8.2 (GH-130171)
(cherry picked from commit 736ad664e0)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-02-18 23:55:11 +00:00
sobolevn
0931693f95
[3.12] gh-130160: use option instead of cmdoption in dis.rst (GH-130255) (#130265) 2025-02-18 17:18:30 +03:00
Miss Islington (bot)
aeefac90b7
[3.12] gh-130160: use .. program:: directive for documenting ensurepip CLI (gh-130253) (gh-130258)
gh-130160: use `.. program::` directive for documenting `ensurepip` CLI (gh-130253)
(cherry picked from commit 8cd7f8bf8d)

Co-authored-by: Kanishk Pachauri <itskanishkp.py@gmail.com>
2025-02-18 12:53:02 +00:00
Miss Islington (bot)
0274115585
[3.12] gh-130214: Document PyEllipsis_Type (GH-130215) (#130224)
gh-130214: Document `PyEllipsis_Type` (GH-130215)
(cherry picked from commit fc8c99a8ce)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
2025-02-17 19:24:30 +03:00
Stan Ulbrych
8a598fb623
[3.12] gh-82045: Correct and deduplicate "isprintable" docs; add test. (GH-130125)
We had the definition of what makes a character "printable" documented in three places, giving two different definitions.
The definition in the comment on `_PyUnicode_IsPrintable` was inverted; correct that.

With that correction, the two definitions turn out to be equivalent -- but to confirm that, you have to go look up, or happen to know, that those are the only five "Other" categories and only three "Separator" categories in the Unicode character database.  That makes it hard for the reader to tell whether they really are the same, or if there's some subtle difference in the intended semantics.

Fix that by cutting the C API docs' and the C comment's copies of the subtle details, in favor of referring to the Python-level docs. That ensures it's explicit that these are all meant to agree, and also lets us concentrate improvements to the wording in one place.

Speaking of which, borrow some ideas from the C comment, along with other tweaks, to hopefully add a bit more clarity to that one newly-centralized copy in the docs.

Also add a thorough test that the implementation agrees with this definition.

Co-authored-by: Greg Price <gnprice@gmail.com>
(cherry picked from commit 3402e133ef)
2025-02-17 14:07:59 +01:00
Miss Islington (bot)
4acf03ce65
[3.12] gh-130169: Fix broken list markup in Doc/c-api/function.rst (GH-130174) (#130176)
gh-130169: Fix broken list markup in `Doc/c-api/function.rst` (GH-130174)
(cherry picked from commit 9837c2a214)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-02-16 11:04:07 +00:00
Miss Islington (bot)
de1279a016
Doc: update term "namespace package" (GH-129251)
(cherry picked from commit e65e9f9062)
Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2025-02-15 15:11:38 +09:00
Miss Islington (bot)
f23ed0c985
[3.12] gh-130106: Fix a typo in unittest.mock doc (GH-130107) (#130144)
gh-130106: Fix a typo in unittest.mock doc (GH-130107)
(cherry picked from commit d2e60d8e59)

Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్  రెడ్డి) <thatiparthysreenivas@gmail.com>
2025-02-15 03:59:08 +00:00
Miss Islington (bot)
719d08cccf
[3.12] gh-129912: Fix references to Py_TPFLAGS_MANAGED_DICT (gh-130044) (gh-130060)
(cherry picked from commit 791cdfe141)

Co-authored-by: Satyam Kumar <isatyamks@gmail.com>
2025-02-12 22:55:30 +00:00
Miss Islington (bot)
b75a72c75b
[3.12] gh-59149: Setup documentation for IDLE on Linux and add section in Editors (GH-130003) (#130028)
---------
(cherry picked from commit 555ee43d92)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-02-12 08:26:30 +00:00
Tomas R.
96a6ee04b1
[3.12] gh-97850: Update the deprecation warning of importlib.abc.Loader.load_module (GH-129855) (GH-130017)
(cherry picked from commit aa81a6f6e4)
2025-02-11 15:31:44 -08:00
Hugo van Kemenade
c62d573a89
[3.12] gh-101100: Docs: Fix some typos in the document (GH-129988) (#129998)
Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2025-02-11 23:31:48 +02:00
Miss Islington (bot)
181e924332
[3.12] gh-46236: Document PyUnicode_DecodeCodePageStateful (GH-127934) (GH-129962)
gh-46236: Document `PyUnicode_DecodeCodePageStateful` (GH-127934)

(cherry picked from commit 8d9d3e4ecb)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-02-10 17:36:10 +01:00
Miss Islington (bot)
08a9b7c385
[3.12] gh-129143: Fix incorrect documentation for logging.Handler.close(). (GH-129950) (GH-129952)
(cherry picked from commit 7c156a63d3)
2025-02-10 11:26:18 +00:00
Miss Islington (bot)
fd8d445cb3
[3.12] gh-129873: IDLE: Improve help.py's method of parsing HTML (GH-129859) (#129885)
gh-129873: IDLE: Improve help.py's method of parsing HTML (GH-129859)

In `help.copy_strip`, only copy the text `<section>`.  In `help.HelpParser.handle_starttag` and elsewhere, remove code to skip the no longer present html.  Add a reminder at the top of idle.rst to run copy_strip after changes.
---------

(cherry picked from commit 6fbf15f98e)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2025-02-09 04:19:55 -05:00
Miss Islington (bot)
d42eba880e
[3.12] gh-64414: mention AF_INET6 and IPv6 in socketserver docs. (GH-129866) (#129869)
gh-64414: mention AF_INET6 and IPv6 in socketserver docs. (GH-129866)

mention AF_INET6 and IPv6 in socketserver docs.
(cherry picked from commit 5ce70ad129)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2025-02-08 20:13:40 +00:00
Miss Islington (bot)
5c527f8ddc
[3.12] gh-129699: Add description to IDLE doc title (GH-129727) (#129865)
gh-129699: Add description to IDLE doc title (GH-129727)

Also extend the 'idlelib' section header. These additions affect both the displayed idle.html file and the contents.html file displayed by clicking the Complete table of contents link on the main docs.python.org page. (The module index entries are generated from the module name and synopsis within module files.)
---------

(cherry picked from commit 33a7094aa6)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2025-02-08 19:42:43 +00:00
Bénédikt Tran
1581c9d936
[3.12] Add multinomial to the itertools recipes docs (gh-129760) (gh-129854) 2025-02-08 08:10:41 -06:00
Miss Islington (bot)
7ff8e8dbd5
[3.12] gh-112020: Rework socketserver examples to be correct (GH-129741) (#129744)
gh-112020: Rework socketserver examples to be correct.

Outdated code updated, the BaseRequestHandler example is now much more
illustrative instead of the bad idea of a single recv() call for TCP.

tested, they now work.
(cherry picked from commit 78377c788e)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2025-02-06 17:53:30 +00:00
Miss Islington (bot)
de9380558b
[3.12] Remove an inaccurate note from socket.recv (GH-129733) (#129735)
Remove an inaccurate note from `socket.recv` (GH-129733)

Remove an inaccurate note from socket.recv.
(cherry picked from commit ded54c3baa)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2025-02-06 09:45:33 -08:00
Adam Turner
3dc5bcee67
[3.12] GH-121970: Extract `implementation_detail` into a new extension (GH-129663) (#129740)
(cherry picked from commit 4d56c40440)
2025-02-06 17:33:13 +00:00
Serhiy Storchaka
0d51b29806
[3.12] Use roles :data: and :const: for referencing module variables (GH-129507) (GH-129650)
(cherry picked from commit 078ab828b9)
2025-02-04 14:30:57 +00:00
Miss Islington (bot)
4879257d0c
[3.12] gh-97850: Remove the mention of removal from ResourceReader docs (GH-128602) (#128655)
gh-97850: Remove the mention of removal from `ResourceReader` docs (GH-128602)

Remove the mention of removal from ResourceReader docs
(cherry picked from commit a1284e9797)

Co-authored-by: Tomas R <tomas.roun8@gmail.com>
2025-02-04 00:29:45 +01:00
Miss Islington (bot)
e4384d1544
[3.12] gh-128696: Add arm64 to the get_platform return val description (GH-128701) (#128773)
gh-128696: Add arm64 to the get_platform return val description (GH-128701)
(cherry picked from commit 553cdc6d68)

Co-authored-by: RUANG (James Roy) <longjinyii@outlook.com>
2025-02-04 00:29:16 +01:00
Miss Islington (bot)
a7645468c2
[3.12] gh-101944: Clarify PyModule_AddObjectRef() documentation (GH-129433) (#129613)
gh-101944: Clarify PyModule_AddObjectRef() documentation (GH-129433)
(cherry picked from commit 04264a286e)

Co-authored-by: Victor Stinner <vstinner@python.org>
2025-02-03 12:02:31 +00:00
Miss Islington (bot)
eff45c9b1e
[3.12] gh-129407: Clarify that a SystemError isn't always CPython's fault (GH-129410) (#129611)
gh-129407: Clarify that a `SystemError` isn't always CPython's fault (GH-129410)
(cherry picked from commit 39b754a359)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-02-03 11:54:16 +00:00
Adam Turner
834b9d65a9
[3.12] GH-121970: Extract `misc_news` into a new extension (GH-129577) (#129587)
(cherry picked from commit ae4788809d)
2025-02-02 16:26:50 +00:00
Miss Islington (bot)
14bd0fc19a
[3.12] gh-126609: Allow translating the `availability` directive (GH-129549) (#129585)
gh-126609: Allow translating the ``availability`` directive (GH-129549)
(cherry picked from commit 0612a89ffc)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-02-02 16:18:50 +00:00
Hugo van Kemenade
580d781094
[3.12] gh-126022: Replace TeX quotation marks with `"` in Doc/license.rst (GH-129535) (#129554)
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-02-01 19:16:38 +02:00
Miss Islington (bot)
ea143e67b3
[3.12] gh-85046: Document errno constants (GH-126420) (#129384)
(cherry picked from commit 1c3bb200da)

Co-authored-by: RUANG (James Roy) <longjinyii@outlook.com>
2025-01-28 00:20:13 +00:00
Miss Islington (bot)
6073f04b73
[3.12] gh-126022: Remove zope.org from the permitted linkcheck redirects (GH-129308) (#129318)
Co-authored-by: partev <petrosyan@gmail.com>
2025-01-26 14:53:46 +00:00
Adam Turner
53204a11f1
[3.12] GH-121970: Remove pyspecific `PyDecoratorMixin` patches (GH-129306) (#129310)
(cherry picked from commit 0ef8d470b7)
2025-01-26 03:54:26 +00:00
Hugo van Kemenade
5431cfac11
[3.12] gh-126022: make license.rst consistent with LICENSE (GH-128516) (#129291)
Co-authored-by: partev <petrosyan@gmail.com>
2025-01-25 15:37:20 +02:00
Miss Islington (bot)
9c44e4fcb1
[3.12] GH-125722: Remove Sphinx patches (GH-129277) (#129279)
GH-125722: Remove Sphinx patches (GH-129277)
(cherry picked from commit d40692db06)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-01-25 03:57:35 +00:00
nikalinov
b849a1b751
[3.12] gh-129044: Update glossary entry for 'loader' to reflect current import system (#129073) (#129130)
* gh-129044: Update glossary entry for 'loader' to reflect current import system (#129073)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
(cherry picked from commit e1fa2fcc7c)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-01-21 23:49:49 +00:00
Miss Islington (bot)
c75dcae879
[3.12] gh-122845: fix parameter_list_starargs in function definition pseudo-grammar (GH-122847) (#129151)
gh-122845: fix parameter_list_starargs in function definition pseudo-grammar (GH-122847)

Thanks to Artur Chakhvadze for bugfix.
(cherry picked from commit 6105846390)

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2025-01-21 20:12:46 +00:00
Miss Islington (bot)
0b66037993
[3.12] Docs: fix typo in Doc/howto/mro.rst (GH-129095) (GH-129121)
(cherry picked from commit da310d209a)

Co-authored-by: smelnikov <13030121+smelnikov@users.noreply.github.com>
2025-01-21 10:40:38 +01:00
Miss Islington (bot)
23cb53a312
[3.12] GH-121970: Extract `changes` into a new extension (GH-129105) (#129110)
GH-121970: Extract ``changes`` into a new extension (GH-129105)
(cherry picked from commit e54ac3b69e)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-01-20 23:59:59 +00:00
Miss Islington (bot)
728c6b89a6
[3.12] doc: fix venv creating for the local Python using uv (GH-129094) (#129097)
Co-authored-by: Filipe Laíns 🇵🇸 <lains@riseup.net>
2025-01-20 21:13:23 +02:00
Miss Islington (bot)
e6cb31a098
[3.12] Docs C API: Clarify what happens when null bytes are passed to PyUnicode_AsUTF8 (GH-127458) (#129081)
Docs C API: Clarify what happens when null bytes are passed to `PyUnicode_AsUTF8` (GH-127458)
(cherry picked from commit e792f4bc2e)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan U. <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Tomas R. <tomas.roun8@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-01-20 16:06:18 +00:00
Miss Islington (bot)
49b2f31a6b
[3.12] GH-125722: Use long options for Sphinx (GH-129039) (#129042)
GH-125722: Use long options for Sphinx (GH-129039)
(cherry picked from commit 4967fa6a9c)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-01-20 09:17:35 +02:00
Miss Islington (bot)
6f19c6a705
[3.12] GH-125722: Increase minimum supported Sphinx to 8.1.3 (GH-128922) (#129038)
(cherry picked from commit d46b577ec0)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-01-20 00:46:05 +00:00
Miss Islington (bot)
22c1d895fc
[3.12] gh-129020: Remove ambiguous sentence from tokenize.untokenize docs (GH-129021) (#129036)
gh-129020: Remove ambiguous sentence from `tokenize.untokenize` docs (GH-129021)
(cherry picked from commit bca35f0e78)

Co-authored-by: Tomas R <tomas.roun8@gmail.com>
2025-01-20 00:12:39 +00:00
Miss Islington (bot)
ae8c8b7ffd
[3.12] gh-128998: Fix indentation of numbered list and literal block (GH-128999) (#129001)
gh-128998: Fix indentation of numbered list and literal block (GH-128999)
(cherry picked from commit e8092e5cdc)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-01-18 21:00:14 +00:00
Miss Islington (bot)
104d37ad99
[3.12] gh-121542: Document trailing newline behavior in set_content() (GH-121543) (#128996)
gh-121542: Document trailing newline behavior in `set_content()` (GH-121543)
(cherry picked from commit fba475ae6f)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Yizheng Meng <dev@rapidcow.org>
2025-01-18 18:41:59 +00:00
Bénédikt Tran
3d9b14c19b
[3.12] gh-125997: suggest efficient alternatives for time.sleep(0) (GH-128752) (#128985) 2025-01-18 11:13:03 +00:00
Miss Islington (bot)
8ee250bdd9
[3.12] Fix definition of a generator iterator in glossary.rst (GH-128952) (#128968)
Fix definition of a `generator iterator` in `glossary.rst` (GH-128952)

Fix possible typo/grammar in glossary.rst

As discussed in https://discuss.python.org/t/typo-in-glossary-entry-for-generator-iterator/77163
(cherry picked from commit 8174770d31)

Co-authored-by: Daniel F Moisset <dfmoisset@gmail.com>
2025-01-18 00:53:29 +00:00
Miss Islington (bot)
1c85f1bc44
[3.12] gh-128017: Make a note that sys variables are read-only (GH-128887) (#128909)
gh-128017: Make a note that sys variables are read-only (GH-128887)
(cherry picked from commit 313b96eb8b)

Co-authored-by: Srinivas Reddy Thatiparthy (తాటిపర్తి శ్రీనివాస్  రెడ్డి) <thatiparthysreenivas@gmail.com>
2025-01-16 10:23:48 +00:00
Miss Islington (bot)
0308bcfa04
[3.12] gh-97850: Suggest TraversableResources as the alternative for ResourceLoader (GH-128601) (GH-128896)
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 256d6d2131)

Co-authored-by: Tomas R <tomas.roun8@gmail.com>
2025-01-15 20:55:06 +00:00