Commit graph

13798 commits

Author SHA1 Message Date
Miss Islington (bot)
c707d38e70
[3.13] gh-139006: Doc: Clarify html.escape function description (GH-139016) (#139037)
gh-139006: Doc: Clarify html.escape function description (GH-139016)
(cherry picked from commit 81c975bcfc)


Doc: Clarify html.escape function description (GH-139006)

Co-authored-by: PrinceNaroliya <naroliyaprince@gmail.com>
2025-09-17 21:54:16 +08:00
Miss Islington (bot)
b0aa4f252e
[3.13] Synced docs and docstring for sysconfig.get_platform (GH-135530) (#138975)
(cherry picked from commit 01cc53295c)

Co-authored-by: ivan <ivandietert@gmail.com>
Co-authored-by: Mikhail Efimov <efimov.mikhail@gmail.com>
Co-authored-by: Ned Deily <nad@python.org>
2025-09-17 13:22:36 +00:00
Miss Islington (bot)
b6d8ec39bd
[3.13] gh-138966: Add description for gi_suspended attribute (GH-139008) (GH-139019)
gh-138966: Add description for `gi_suspended` attribute (GH-139008)
(cherry picked from commit c025576a8f)

Co-authored-by: Donghoon Nam <54799053+codenamenam@users.noreply.github.com>
2025-09-17 04:42:13 -04:00
Miss Islington (bot)
a5f7e02ddf
[3.13] gh-138005: Document that CSV skipinitialspace=True and delimiter=' ' require quotation for empty fields (GH-138006) (#138799)
Co-authored-by: Maurycy Pawłowski-Wieroński <5383+maurycy@users.noreply.github.com>
2025-09-11 15:18:42 +00:00
Spider84pr
e5bbcb1605
[3.13] gh-138556: Fix old link in gc docs (#138596) 2025-09-07 10:53:56 +03:00
Adam Turner
e7bb98a173
[3.13] GH-138465: Improve documentation for common sequence methods (GH-138474) (#138567)
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2025-09-05 21:39:32 +00:00
Miss Islington (bot)
bb64bc357f
[3.13] gh-137985: Correct description of Formatter's datefmt param in logging documentation (GH-138530) (GH-138566)
(cherry picked from commit 8368895049)
Co-authored-by: W. H. Wang <mattwang44@gmail.com>
2025-09-05 22:32:49 +01:00
Miss Islington (bot)
4e25f012e7
[3.13] gh-138307: Update the Ellipsis documentation (GH-138306) (#138439)
(cherry picked from commit 88665de120)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2025-09-05 13:47:19 -07:00
Miss Islington (bot)
08e9794517
[3.13] Docs: Fix typo in os.fwalk() example (GH-138486) (GH-138501)
Docs: Fix typo in `os.fwalk()` example (GH-138486)
(cherry picked from commit 849a80ec41)

Co-authored-by: William Andrea <22385371+wjandrea@users.noreply.github.com>
2025-09-04 12:39:58 +00:00
Miss Islington (bot)
b8f9b6bc23
[3.13] GH-101100: Resolve reference warnings in whatsnew/3.5.rst (GH-138412) (#138460)
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-09-03 20:58:54 +00:00
Miss Islington (bot)
a62b59a96e
[3.13] Fix Windows path in venv docs (GH-138478)
(cherry picked from commit f8d9cb1407)
2025-09-03 20:22:05 +00:00
Miss Islington (bot)
1ca2a4d54d
[3.13] GH-101100: Resolve reference warnings in whatsnew/3.4.rst (GH-138413) (#138444)
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-09-03 15:47:22 +00:00
Miss Islington (bot)
1943877c66
[3.13] GH-101100: Resolve reference warnings in whatsnew/2.7.rst (GH-138415) (#138442)
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-09-03 11:42:23 +00:00
Miss Islington (bot)
45e5ee46a1
[3.13] GH-101100: Resolve reference warnings in whatsnew/3.8.rst (GH-138409) (#138438)
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-09-03 11:32:17 +00:00
Miss Islington (bot)
005c43a249
[3.13] GH-101100: Resolve reference warnings in whatsnew/3.3.rst (GH-138414) (#138436)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-09-03 11:28:33 +00:00
Miss Islington (bot)
154ec76def
[3.13] GH-101100: Resolve reference warnings in whatsnew/3.7.rst (GH-138410) (#138424)
GH-101100: Resolve reference warnings in whatsnew/3.7.rst (GH-138410)

Resolve reference warnings in whatsnew/3.7.rst
(cherry picked from commit dd86fb4ba5)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-09-03 06:27:17 +00:00
Miss Islington (bot)
01d95d4b0f
[3.13] gh-101100: Resolve reference warnings in library/xml.sax.handler.rst (GH-136612) (#138422)
Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
2025-09-03 00:43:18 +00:00
Miss Islington (bot)
76aa2abdef
[3.13] gh-54874: Expand unicodedata module documentation (GH-138301) (#138345)
* gh-54874: Expand unicodedata module documentation (GH-138301)

Closes GH-54874
(cherry picked from commit 0d383f86ee)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Alexander Belopolsky <abalkin@users.noreply.github.com>

* Changes links to UCD 15.0.0

---------

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Alexander Belopolsky <abalkin@users.noreply.github.com>
2025-09-01 18:18:57 +02:00
Miss Islington (bot)
6d2958583e
[3.13] gh-133829: Remove some specifics from the `zipimport` example (GH-133835) (#138273)
Co-authored-by: R Chintan Meher <meherrihaan@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: sobolevn <mail@sobolevn.me>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-08-31 00:59:47 +00:00
Miss Islington (bot)
e93cacb8cf
[3.13] gh-123858: Improve Doc: SyntaxWarning is emitted during bytecode generation (gh-138243)
---------
(cherry picked from commit 5f7906715a)

Co-authored-by: Hang <bebound@gmail.com>
Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
2025-08-30 00:35:17 +10:00
Miss Islington (bot)
d6a346055b
[3.13] Docs: Fix typo in shutil.make_archive example (GH-138188) (GH-138196)
Docs: Fix typo in `shutil.make_archive` example (GH-138188)
(cherry picked from commit f733e428f8)

Co-authored-by: Andreas Pelme <andreas@pelme.se>
2025-08-27 16:03:28 +00:00
Miss Islington (bot)
d6f7c615c0
[3.13] gh-106318: Add example for str.find() (GH-134529) (#138175)
Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-08-27 06:49:19 +00:00
Serhiy Storchaka
bad7bc49f1
[3.13] gh-137609: Update signatures of builtins in the documentation (GH-137610) (GH-138138)
Show signatures that match the actual signatures or future multisignatures
for all functions, classes and methods in the "builtins" module.
(cherry picked from commit 65fb4d11a0)
2025-08-25 12:40:09 +00:00
Serhiy Storchaka
59068dfcf4
[3.13] gh-137986: Fix and improve the csv functions docstrings (GH-137987) (GH-138108)
The csv.register_dialect() docstring no longer imply that it returns a
dialect.
All functions have now signatures.
(cherry picked from commit aa1dbd4dde)

Co-authored-by: maurycy <5383+maurycy@users.noreply.github.com>
2025-08-24 08:37:41 +00:00
Bénédikt Tran
3afc263c41
[3.13] gh-136134: imaplib: fix CRAM-MD5 on FIPS-only environments (GH-136615) (#138055)
(cherry picked from commit 4519b8acb5)
2025-08-23 13:01:36 +02:00
Miss Islington (bot)
57b5baf3f9
[3.13] gh-133125: Clarify ZipInfo.date_time attribute documentation (GH-136082) (#138076)
gh-133125: Clarify ZipInfo.date_time attribute documentation (GH-136082)

Specifically, clarify that ZipInfo.date_time pulls the datetime information from the central directory, and that times are interpreted as local time.
(cherry picked from commit 282e88506b)

Co-authored-by: Kentaro Jay Takahashi <64148935+KentaroJay@users.noreply.github.com>
Co-authored-by: Emma Smith <emma@emmatyping.dev>
2025-08-22 17:01:37 -07:00
Miss Islington (bot)
2aeae241ca
[3.13] gh-91116: Add hyperlink from sys.settrace to frame objects (GH-138062) (GH-138069)
gh-91116: Add hyperlink from `sys.settrace` to frame objects (GH-138062)
(cherry picked from commit f278afcabf)

Co-authored-by: Krishna Chaitanya <141550576+XChaitanyaX@users.noreply.github.com>
2025-08-22 14:25:55 -04:00
Miss Islington (bot)
47b1c5d74e
[3.13] gh-137900: Improve dataclasses frozen parameter documentation (GH-137937) (#137991)
gh-137900: Improve dataclasses frozen parameter documentation (GH-137937)
(cherry picked from commit 7685b8ada8)

Co-authored-by: Tangyuan <47830915@qq.com>
2025-08-20 13:15:39 +00:00
Miss Islington (bot)
422a317657
[3.13] Fix typo in logging docs (GH-137981) (GH-137984)
Fix typo in `logging` docs (GH-137981)
(cherry picked from commit 9b5235b62e)

Co-authored-by: Maximilian Linhoff <maximilian.linhoff@cta-observatory.org>
2025-08-20 11:13:53 +00:00
Serhiy Storchaka
511b37a602
[3.13] Update the dbm documentation (GH-137919) (GH-137963)
Unify documentation for all backends, enumerate all not implemented mapping
methods, document particularities of implemented mapping methods.
(cherry picked from commit 8700404f86)
2025-08-19 20:39:08 +03:00
Miss Islington (bot)
8aabea7a0e
[3.13] [docs] fix grammar in ssl.SSLContect.sslsocket_class docs (GH-137935) (#137951)
[docs] fix grammar in ssl.SSLContect.sslsocket_class docs (GH-137935)

---------
(cherry picked from commit 379161dd51)

Co-authored-by: PrinceNaroliya <naroliyaprince@gmail.com>
Co-authored-by: Gregory P. Smith <68491+gpshead@users.noreply.github.com>
2025-08-19 14:22:42 +02:00
Miss Islington (bot)
8ce1698ebf
[3.13] gh-127859: Fixed documentation for call_later and call_at for early wakeup in asyncio (GH-137859) (#137907)
Co-authored-by: Bar Harel <bzvi7919@gmail.com>
2025-08-19 14:27:30 +03:00
Miss Islington (bot)
d1882577a3
[3.13] gh-44538: Mention nested classes/functions in doctest docs (GH-137870) (GH-137917)
gh-44538: Mention nested classes/functions in doctest docs (GH-137870)
(cherry picked from commit 138ed6db9f)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
2025-08-18 15:05:12 +00:00
Miss Islington (bot)
1a10c47fae
[3.13] gh-135862: add C contiguous one-dimensional buffer requirement to asyncio.StreamWriter docs (GH-137910) (#137913)
gh-135862: add C contiguous one-dimensional buffer requirement to `asyncio.StreamWriter` docs (GH-137910)
(cherry picked from commit 1c3950abc1)

Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2025-08-18 13:13:19 +00:00
Adam Turner
135e8343a4
[3.13] gh-131885: Use positional-only markers for the `decimal` module (GH-131990) (#137904)
Co-authored-by: Semyon Moroz <donbarbos@proton.me>
2025-08-18 11:59:24 +00:00
Miss Islington (bot)
133f7bd22b
[3.13] gh-137846: Add missing 'be' to profile doc. (GH-137856) (#137858)
gh-137846: Add missing 'be' to profile doc. (GH-137856)

Insert 'be' into 'will interpreted'.
(cherry picked from commit 3663b2ad54)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2025-08-16 10:56:21 -04:00
Miss Islington (bot)
33a3f5e458
[3.13] gh-90483: fix docs of SubprocessTransport.get_pipe_transport (GH-137852) (#137854)
gh-90483: fix docs of `SubprocessTransport.get_pipe_transport ` (GH-137852)
(cherry picked from commit 038a6e3b95)

Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2025-08-16 11:17:55 +00:00
Miss Islington (bot)
7f18b0e45d
[3.13] gh-101359: clarify docs for asyncio.Event.clear (GH-137849) (#137851)
gh-101359: clarify docs for `asyncio.Event.clear` (GH-137849)
(cherry picked from commit 4b2dbe8e0a)

Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2025-08-16 16:29:26 +05:30
Miss Islington (bot)
83e4b43626
[3.13] gh-137777: Disband the 'Program Frameworks' chapter (GH-137796) (#137831)
Co-authored-by: rimchoi <hyerimc858@gmail.com>
2025-08-15 17:50:47 +00:00
Miss Islington (bot)
2c614a8264
[3.13] Mention the "context manager" keyword in concurrent.futures documentation (GH-130976) (#137811)
Mention the "context manager" keyword in concurrent.futures documentation (GH-130976)
(cherry picked from commit 095bc775ec)

Co-authored-by: Jakub Stasiak <jakub@stasiak.at>
2025-08-15 19:41:04 +05:30
Miss Islington (bot)
929a77cfce
[3.13] gh-137760: Update REPL constants documentation (gh-137798) (gh-137823)
gh-137760: Update REPL constants documentation (gh-137798)
(cherry picked from commit d6719c6be6)

Co-authored-by: Chaemin-Lim <antraxmin@naver.com>
2025-08-15 13:59:18 +00:00
Miss Islington (bot)
9417ea5941
[3.13] gh-87281: Improve documentation for locale.setlocale() and locale.getlocale() (GH-137313) (GH-137723)
Add a section explaining the locale name formats.
(cherry picked from commit 15ab45775c)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2025-08-13 21:11:25 +03:00
Serhiy Storchaka
3a74d52584
[3.13] gh-137668: Document that ord() supports also bytes and bytearray (GH-137669) (GH-137704)
(cherry picked from commit 35759fe2fa)
2025-08-13 09:37:15 +00:00
Miss Islington (bot)
85637f0bd9
[3.13] gh-136672: Docs: Move Enum functions and add examples (GH-136791) (#137689)
Co-authored-by: RafaelWO <38643099+RafaelWO@users.noreply.github.com>
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2025-08-12 21:27:50 +01:00
Miss Islington (bot)
c1e1c880ee
[3.13] gh-131885: Use positional-only markers for `max() and min()` (GH-131868) (#137657)
Co-authored-by: Evan Kohilas <ekohilas@users.noreply.github.com>
2025-08-11 23:37:52 +00:00
Miss Islington (bot)
8531f5b52a
[3.13] gh-125897: Mark range function parameters as positional only (GH-125945) (#137653)
Co-authored-by: Konstantin Baikov <konstantin.baikov@gmail.com>
2025-08-12 00:26:02 +01:00
Miss Islington (bot)
a64c9488ac
[3.13] gh-137499: Fixed dead link to NIST website (GH-137500) (#137501)
Co-authored-by: tobiasjcat <70606111+tobiasjcat@users.noreply.github.com>
Co-authored-by: Senthil Kumaran <senthil@python.org>
2025-08-09 13:42:25 +01:00
Miss Islington (bot)
ddf951c616
[3.13] gh-137026: Add an explainer guide for asyncio (GH-137215) (#137582)
gh-137026: Add an explainer guide for asyncio (GH-137215)

* - Add an explainer guide (aka HOWTO, not how-to) for asyncio.

* Fix linter errors.

* - Enforce max line length of roughly 79 chars.
- Start sentences on new lines to minimize disruption of diffs.

* Add reference to subinterpreters.

* - Significantly reduce article size. Remove both example sections & "Which concurrency do I want" section.

* Align section-header lengths with section names.

* - Remove reference to deleted section.

* - Fix a variety of rote style guide items like title-alignment, use of ie and $, and so forth.
- Add links to other parts of the docs for keywords and objects like await, coro, task, future, etc.

* - One last title alignment.

* - Style nit.

* - Rework a variety of I statements.

* Lint fix.

* - Firm up commentary on yield from in corotuines.

* Update language comparing await and yield from.

* - Remove await-ing Tasks and futures section

* Update Doc/howto/a-conceptual-overview-of-asyncio.rst



* Update Doc/howto/a-conceptual-overview-of-asyncio.rst



* - Address comments related to style & writing flow.

* per-thread event loop note.

* Add section describing coroutines roots in generators.

* Phrasing tweak.

* Use asyncio.create_task instead of asyncio.Task

* Update Doc/howto/a-conceptual-overview-of-asyncio.rst



* Update Doc/howto/a-conceptual-overview-of-asyncio.rst



* small phrasing.

* Update Doc/howto/a-conceptual-overview-of-asyncio.rst



* phrasing nit.

* style nits

* Update Doc/howto/a-conceptual-overview-of-asyncio.rst



* phrasing nit

* Fix misnaming of async generator.

* phrasing nits.

* Update Doc/howto/a-conceptual-overview-of-asyncio.rst



* Update Doc/howto/a-conceptual-overview-of-asyncio.rst



* consistent spacing

* Update Doc/howto/a-conceptual-overview-of-asyncio.rst



* phrasing nits

* Update Doc/howto/a-conceptual-overview-of-asyncio.rst



* Update Doc/howto/a-conceptual-overview-of-asyncio.rst



* Update Doc/howto/a-conceptual-overview-of-asyncio.rst



* Update Doc/howto/a-conceptual-overview-of-asyncio.rst



* add conclusion

* nits

* - Variety of style & grammar improvements thanks to ZeroIntensity's comments.

* - Make all directives start with a 3 space indent. Then 4 thereafter.

* - Use :linenos: instead of manually writing the line numbers.

* - Fix label typo for article.

* fix label link.

* Apply suggestions from code review





* - introduce async-sleep name

* Phrasing

* nit

* ungendered octopus

* teammates

* jobs

* rework fella to penguin

* - remove byline; add seealso

* Change ref from asyncio to use seealso block.

* Remove typehints. Fix indentation in one code example.

* Slight rephrase for clarity.

* Make references point to asyncio. Wrap some long lines.

* - Variety of style/phrasing improvements based on PR feedback.

* phrasing.

* phrasing nit.

* Apply suggestions from code review



* Update Doc/howto/a-conceptual-overview-of-asyncio.rst



* nit

* Apply suggestions from code review



* fix backticks.

* nits

* nit

* add section on asyncio.run

* title change under the hood.

* modify task coro example.

* howtos article link.

* prefer await without backticks.

* phrasing tweak.

* Rework phrasing around how await tasks pauses and returns control in the await section.

* move code block to beforfe explanation in coroutine under the hood.

* phrasing.

* link to yield from.

* style nits

* nit

* - Modify language re: event-loop cycling endlessly.
- Discuss why await was designed to not yield for coros.

* - Add a note about debug=True on asyncio.run to await coro section.

* clarity nit

* - Add two other references in seealso block.

* nit

* Language simplification

* Apply suggestions from code review



* nit

* grammar fix.

* fix

* worker bees

* rework event loop paragraph to significantly deemphasize queues

* remove all references to queue besides the initial analogy.

* add note about garbage collection of tasks

* add practical note re: garbage collection

* phrasing nits

* re arrange note on task gc.

* line wrap nit

* Update Doc/howto/a-conceptual-overview-of-asyncio.rst



* link to debug mode docs.

* readd part2 prefix.

* simplify title.

* fix titles. tihnk I messed this up earlier.

* avoid idiom in title.

* fix titles once agian.

* Apply suggestions from code review



* rework task gc example.

* phrasing tweak.

* tewak.

* nit

* nit

* nit

* nit

---------
(cherry picked from commit 3964f97489)

Co-authored-by: Alexander Nordin <alexander.f.nordin@gmail.com>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-08-09 05:35:38 +00:00
Miss Islington (bot)
74c3805cef
[3.13] Replace "ordered arguments" with "positional arguments" in unittest.mock documentation (GH-137552) (GH-137554)
Replace "ordered arguments" with "positional arguments" in `unittest.mock` documentation (GH-137552)
(cherry picked from commit 64ee1babfb)

Co-authored-by: Tom Forbes <tom@tomforb.es>
2025-08-08 14:08:01 +00:00
Miss Islington (bot)
3491368f22
[3.13] [Doc] Remove unnecessary quotes from typing module (GH-137207) (#137540)
[Doc] Remove unnecessary quotes from typing module (GH-137207)

* gh-106320: Remove private _PyInterpreterState functions (GH-106335)

Remove private _PyThreadState and _PyInterpreterState C API
functions: move them to the internal C API (pycore_pystate.h and
pycore_interp.h). Don't export most of these functions anymore, but
still export functions used by tests.

Remove _PyThreadState_Prealloc() and _PyThreadState_Init() from the C
API, but keep it in the stable API.

* Doc: minor change

* Revert "Doc: minor change"

This reverts commit ebfa0937c2.

* [Doc] Remove unnecessary quotes from typing (See Also section)

* [Doc] Remove unnecessary quotes from typing

---------
(cherry picked from commit f06fcb7f4b)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-08-08 02:21:21 +00:00