Commit graph

28026 commits

Author SHA1 Message Date
Miss Islington (bot)
245ca2607c
[3.12] GH-121970: Extract `issue_role` into a new extension (GH-130615) (#130652)
(cherry picked from commit 043ab3af9a)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-02-27 21:29:33 +00:00
Hugo van Kemenade
a55a9cd6c2
[3.12] GH-92897: schedule the check_home deprecation to 3.15 (GH-129102) (#130585)
Co-authored-by: Filipe Laíns 🇵🇸 <lains@riseup.net>
2025-02-27 18:17:08 +00:00
Petr Viktorin
a678d8e511
[3.12] gh-129405: Fix doc for Py_mod_multiple_interpreters default, and add test (GH-129406) (GH-130510) 2025-02-27 16:30:46 +01:00
Miss Islington (bot)
c7ac503f4b
[3.12] Doc: Strip trailing whitespace in `pydoc_topics` (GH-130492) (#130636)
(cherry picked from commit 3f3e1c4095)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-02-27 14:26:42 +00:00
Adam Turner
fb073b5e3b
[3.12] GH-121970: Extract pydoc_topics into a new extension (#129116) (#130443)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-02-27 14:18:54 +00:00
Miss Islington (bot)
6a268a046f
[3.12] Fix indentation for contextlib.asynccontextmanager docs (GH-127333) (#130580)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2025-02-26 15:03:18 +02:00
Miss Islington (bot)
7575abb9d9
[3.12] Docs: Fix some semantic usages of iterator.__iter__ (GH-130172) (GH-130544)
These references to an `__iter__` method mean `object.__iter__`, not `iterator.__iter__`.
(cherry picked from commit 4d3a7ea354)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
2025-02-26 11:03:00 +01:00
Miss Islington (bot)
2592402bba
[3.12] gh-130433: Update documentation for MultipartConversionError (GH-130436) (GH-130566)
(cherry picked from commit b536e37104)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
2025-02-26 09:59:19 +01:00
Kanishk Pachauri
ca9e52dac1
[3.12] gh-130461: Remove unnecessary usages of .. index:: directives in Doc/library/uuid.rst (#130526) (#130546)
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>
2025-02-25 15:25:20 +02:00
Miss Islington (bot)
e38cded312
[3.12] gh-46236: Add docs for PyUnicode_GetDefaultEncoding() doc (GH-130335) (GH-130512)
* Clarify sys.getdefaultencoding() documentation

* Add missing documentation for PyUnicode_GetDefaultEncoding,
  the C equivalent of sys.getdefaultencoding
(cherry picked from commit 9f25c1f012)

Co-authored-by: RUANG (James Roy) <longjinyii@outlook.com>
2025-02-24 17:10:27 +01:00
Miss Islington (bot)
3c20e8bc3a
[3.12] gh-127522: wsgiref: indicate that start_response objects should follow a specific protocol (GH-127525) (GH-130505)
(cherry picked from commit 39ba4b6619)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-02-24 15:08:22 +01:00
Miss Islington (bot)
da471d9d79
[3.12] gh-127805: Clarify Formatter initialization in logging.rst. (GH-127850) (#130393)
gh-127805: Clarify Formatter initialization in logging.rst. (GH-127850)
(cherry picked from commit 5d66c55c8a)

Co-authored-by: UV <yuvrajpradhan667@gmail.com>
2025-02-23 23:01:30 -05:00
Miss Islington (bot)
b505d0f609
[3.12] gh-130160: use .. program:: directive for documenting idle CLI (GH-130278) (#130495)
gh-130160: use `.. program::` directive for documenting `idle` CLI (GH-130278)

---------




(cherry picked from commit 0ff1611574)

Co-authored-by: Kanishk Pachauri <itskanishkp.py@gmail.com>
2025-02-23 22:58:42 -05:00
Adam Turner
ac455678e7
[3.12] Docs: Test presence of optional extensions with importlib (GH-130445) (#130466)
* [3.12] Docs: Test presence of optional extensions with importlib (GH-130445)
(cherry picked from commit 3cc9e867eb)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-02-22 21:06:13 +00:00
Adam Turner
9bd92fa241
[3.12] gh-121970: Replace .. coroutine{method,function} with :async: (GH-130448) (#130467)
(cherry picked from commit 5ec4bf86b7)

Co-authored-by: sobolevn <mail@sobolevn.me>
2025-02-22 18:22:29 +00:00
Miss Islington (bot)
6c59ea6f14
[3.12] Add measuring unit to sys.getswitchinterval docs (GH-130457) (#130459)
Add measuring unit to `sys.getswitchinterval` docs (GH-130457)
(cherry picked from commit 89d8b2d14b)

Co-authored-by: sobolevn <mail@sobolevn.me>
2025-02-22 16:13:31 +00:00
Miss Islington (bot)
8559dc3124
[3.12] gh-129712: Document the wheels tags corresponding to each universal SDK. (GH-130389) (#130450)
Document the architectures supported by macOS universal SDK configuration flags,
and add details on wheel tag naming.
(cherry picked from commit 474c388740)

Co-authored-by: Russell Keith-Magee <russell@keith-magee.com>
2025-02-22 08:38:41 +00:00
Adam Turner
35c30608e3
[3.12] GH-121970: Replace custom abstract method directive with the `:abstract:` option (GH-129311) (#130440)
(cherry picked from commit 30e892473e)
2025-02-22 02:11:47 +00:00
Miss Islington (bot)
f452b81b8d
[3.12] gh-130159: Fix list indentation in collections.abc (GH-130165) (#130438)
gh-130159: Fix list indentation in collections.abc (GH-130165)
(cherry picked from commit 8e96adf453)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-02-22 01:48:15 +00:00
Hugo van Kemenade
546ac0191f
[3.12] Itertool recipe additions (gh-127483) (gh-130362) 2025-02-20 17:32:35 -06:00
Miss Islington (bot)
5c0aba0b81
[3.12] gh-46236: Document PyUnicode_RSplit, PyUnicode_Partition and PyUnicode_RPartition (GH-130191) (#130361)
gh-46236: Document PyUnicode_RSplit, PyUnicode_Partition and PyUnicode_RPartition (GH-130191)
(cherry picked from commit 0f5b82169e)

Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-02-20 15:50:37 +00:00
Miss Islington (bot)
77cba87472
[3.12] [doc]: Update logging cookbook to mention domain socket configuration in a recipe. (GH-130348) (GH-130352)
(cherry picked from commit 8cbcf51d61)
2025-02-20 14:20:00 +00:00
Miss Islington (bot)
e6c3dd3487
[3.12] gh-101100: Fix sphinx warnings in readline.rst (GH-130300) (#130347)
Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-02-20 15:39:09 +02:00
Miss Islington (bot)
16a06be016
[3.12] gh-130130: Clarify hash=False docs in dataclasses.field (GH-130324) (#130336)
gh-130130: Clarify `hash=False` docs in `dataclasses.field` (GH-130324)
(cherry picked from commit 47ace53995)

Co-authored-by: Sabfo <alpha.sabfo@gmail.com>
2025-02-20 07:53:58 +00:00
Miss Islington (bot)
8d58070d7e
[3.12] gh-130250: fix regression in traceback.print_last (GH-130318) (#130326)
gh-130250: fix regression in traceback.print_last (GH-130318)
(cherry picked from commit 6c982aeb54)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2025-02-19 22:01:32 +00:00
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