Commit graph

12658 commits

Author SHA1 Message Date
Miss Islington (bot)
6a5aab0cb4
[3.12] gh-106310 - document the __signature__ attribute (GH-106311) (#111145)
Co-authored-by: Gouvernathor <44340603+Gouvernathor@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-10-23 18:49:12 +03:00
Miss Islington (bot)
06fe8685a1
[3.12] gh-101100: Fix sphinx warnings in library/asyncio-dev.rst (GH-111179) (#111185)
gh-101100: Fix sphinx warnings in `library/asyncio-dev.rst` (GH-111179)

* gh-101100: Fix sphinx warnings in `library/asyncio-dev.rst`

* Update Doc/library/asyncio-eventloop.rst

* Update Doc/library/asyncio-eventloop.rst

---------

(cherry picked from commit 8c689c9b88)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2023-10-22 10:28:09 -07:00
Miss Islington (bot)
b4c215e82d
[3.12] gh-101100: Fix sphinx warnings in library/codecs.rst (GH-110979) (#111070)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-20 11:09:18 +03:00
Miss Islington (bot)
909225172a
[3.12] gh-101100: Fix Sphinx warnings in library/tty.rst (GH-111079) (#111097)
gh-101100: Fix Sphinx warnings in `library/tty.rst` (GH-111079)

Fix Sphinx warnings in library/tty.rst
(cherry picked from commit c42c68aa7b)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-20 07:49:41 +03:00
Hugo van Kemenade
41dfae8f86
[3.12] gh-101100: Fix sphinx warnings in library/getpass.rst (GH-110461) (#111080)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-10-19 15:38:58 +00:00
Miss Islington (bot)
3e9d84c94c
[3.12] gh-109510: Clearly explain "Which Docstrings Are Examined" (GH-109696) (#111077)
Co-authored-by: Unique-Usman <86585626+Unique-Usman@users.noreply.github.com>
Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
Co-authored-by: Jacob Coffee <jacob@z7x.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-10-19 18:35:04 +03:00
Miss Islington (bot)
91a6e98e92
[3.12] GH-101100: Fix reference warnings for `__enter__ and __exit__` (GH-110112) (#111075)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-10-19 18:34:25 +03:00
Miss Islington (bot)
cdcab408a0
[3.12] GH-101100: Fix reference warnings for `__getitem__` (GH-110118) (#111073)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-10-19 18:33:03 +03:00
Brandt Bucher
d312135764
[3.12] GH-103082: Clean up the sys.monitoring docs (GH-111048)
(cherry picked from commit 1991694117)
2023-10-18 23:30:13 +00:00
Miss Islington (bot)
9ef8caf293
[3.12] GH-104232: Fix statement about trace return values (GH-111047)
(cherry picked from commit d9246c7b73)
2023-10-18 23:22:03 +00:00
Miss Islington (bot)
ae838afe35
[3.12] gh-107457: update dis documentation with changes in 3.12 (GH-108900) (#110985)
gh-107457: update dis documentation with changes in 3.12 (GH-108900)
(cherry picked from commit 198aa67d4c)

Co-authored-by: Matthieu Dartiailh <m.dartiailh@gmail.com>
2023-10-18 00:38:42 +02:00
Miss Islington (bot)
744f752f04
[3.12] gh-101100: Fix sphinx warnings in library/time.rst (GH-110862) (#110877)
gh-101100: Fix sphinx warnings in `library/time.rst` (GH-110862)
(cherry picked from commit 12deda7633)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-10-14 14:28:58 +00:00
Miss Islington (bot)
1a7afa7ef4
[3.12] gh-110703: Add asyncio.wait_for() change notes for 3.11 (GH-110818) (#110826)
gh-110703: Add asyncio.wait_for() change notes for 3.11 (GH-110818)

* Remove redundant versionchanged

* Add missing versionchanged

* Update Doc/library/asyncio-task.rst



---------

(cherry picked from commit f81e36f700)

Co-authored-by: paskozdilar <53006174+paskozdilar@users.noreply.github.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2023-10-13 13:24:28 +00:00
Ezio Melotti
7d5a982609
[3.12] gh-110631: Fix reST indentation (GH-110724) (#110738)
* Fix wrong indentation in the other dirs.

* Fix more wrong indentation..
(cherry picked from commit 718391f475)
2023-10-11 23:12:36 +02:00
Miss Islington (bot)
cae968ba17
[3.12] gh-110631: Fix reST indentation in Doc/library (GH-110685) (#110736)
gh-110631: Fix reST indentation in `Doc/library` (GH-110685)

Fix wrong indentation in the Doc/library dir.
(cherry picked from commit bb7923f556)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-10-11 23:11:28 +02:00
Hugo van Kemenade
e6c53dd085
[3.12] gh-108826: Document dis module CLI and rename _test function to main (#108827) (#110681)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Radislav Chugunov <52372310+chgnrdv@users.noreply.github.com>
2023-10-11 14:47:38 -06:00
Miss Islington (bot)
80e4abe0ce
[3.12] gh-101100: Fix sphinx warnings in library/socketserver.rst (GH-110207) (GH-110623)
(cherry picked from commit 756062b296)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-10-10 14:10:22 +02:00
Miss Islington (bot)
a7fe709fef
[3.12] gh-110497: Add note about OSError being an alias to IOError in docs (GH-110498) (#110546)
gh-110497: Add note about `OSError` being an alias to `IOError` in docs (GH-110498)
(cherry picked from commit 5e7edac771)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-10-09 11:42:17 +02:00
Miss Islington (bot)
b77f5eea70
[3.12] Fix typo in Doc/library/textwrap.rst (GH-110328) (#110473)
Co-authored-by: InSync <122007197+InSyncWithFoo@users.noreply.github.com>
2023-10-06 14:33:16 +00:00
Miss Islington (bot)
93279cc8b8
[3.12] gh-110383: Swap 'the all' -> 'all the' in socket docs (GH-110434) (#110435)
Co-authored-by: Bradley Reynolds <bradley.reynolds@darbia.dev>
2023-10-05 14:14:22 -06:00
Miss Islington (bot)
5b66fe8304
[3.12] gh-110383 TimeIt Docs Spelling Fix (GH-110407) (#110409)
gh-110383 TimeIt Docs Spelling Fix (GH-110407)

Make 0.2 second plural
(cherry picked from commit a973bf0f97)

Co-authored-by: Towster15 <105541074+Towster15@users.noreply.github.com>
2023-10-05 17:42:52 +00:00
Miss Islington (bot)
4da8c1b61e
[3.12] Remove duplicate word. (GH-110376) (GH-110377)
Remove duplicate word. (GH-110376)
(cherry picked from commit 313aa861ce)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2023-10-05 04:26:44 +00:00
Miss Islington (bot)
36a7d6becd
[3.12] Add back bltin-boolean-values ref tag (GH-110371) (#110372)
Add back bltin-boolean-values ref tag (GH-110371)

To avoid breaking downstream intersphinx via numpydoc
(cherry picked from commit f7860295b1)

Co-authored-by: P. L. Lim <2090236+pllim@users.noreply.github.com>
2023-10-04 20:05:21 +00:00
Miss Islington (bot)
7ec34874e3
[3.12] gh-85984: Document change in return type of tty functions (GH-110028) (#110324)
gh-85984: Document change in return type of tty functions (GH-110028)
(cherry picked from commit f02f26e293)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-10-04 13:57:14 +02:00
Miss Islington (bot)
ee2f2bdb30
[3.12] Enhance TypedDict docs around required/optional keys (GH-109547) (#109982)
Enhance TypedDict docs around required/optional keys (GH-109547)

As discussed in comments to GH-109544, the semantics of this attribute
are somewhat confusing. Add a note explaining its limitations and
steering users towards __required_keys__ and __optional_keys__ instead.
(cherry picked from commit f49958c886)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-10-04 13:56:58 +02:00
Adam Turner
4c0f42bbc6
[3.12] Docs: Avoid the deprecated `.. cmdoption::` directive (GH-110292) (#110302)
[3.12] Docs: Avoid the deprecated ``.. cmdoption::`` directive (GH-110292).
(cherry picked from commit 77e9aae383)
2023-10-03 20:55:29 +03:00
Miss Islington (bot)
90dea557bb
[3.12] gh-109234: Hint to contextlib.closing in sqlite3 context manager docs (GH-109322) (#110294)
(cherry picked from commit 4227bfa8b2)

Co-authored-by: Lincoln <71312724+Lincoln-developer@users.noreply.github.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-10-03 16:02:44 +00:00
Raymond Hettinger
221c8d64e6
[3.12] Sync factor() recipe with main branch (gh-110231) 2023-10-02 14:19:46 -05:00
Alex Waygood
25bf0564c4
[3.12] Fix typos in docs and comments (#109619) (#109621)
Fix typos in docs and comments (#109619)

Co-authored-by: Heinz-Alexander Fuetterer <35225576+afuetterer@users.noreply.github.com>
2023-10-02 17:34:49 +00:00
Miss Islington (bot)
b61a4da459
[3.12] gh-109590: Update shutil.which on Windows to prefer a PATHEXT extension on executable files (GH-109995) (#110202)
gh-109590: Update shutil.which on Windows to prefer a PATHEXT extension on executable files (GH-109995)

The default arguments for shutil.which() request an executable file, but extensionless files are not executable on Windows and should be ignored.
(cherry picked from commit 29b875bb93)

Co-authored-by: Charles Machalow <csm10495@gmail.com>
2023-10-02 17:48:30 +02:00
Victor Stinner
5245b97e13
[3.12] gh-109649: Enhance os.cpu_count() documentation (#110169)
* gh-109649: Enhance os.cpu_count() documentation

* Doc: Specify that os.cpu_count() counts *logicial* CPUs.
* Doc: Specify that os.sched_getaffinity(0) is related to the calling
  thread.
* Fix test_posix.test_sched_getaffinity(): restore the old CPU mask
  when the test completes!

* Restore removed text
2023-10-02 17:47:57 +02:00
Miss Islington (bot)
b8a30a4365
[3.12] Add example for linear_regression() with proportional=True. (gh-110133) (#110134)
Add example for linear_regression() with proportional=True. (gh-110133)
(cherry picked from commit 613c0d4e86)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2023-10-02 17:47:28 +02:00
Miss Islington (bot)
5ba9d2b98f
[3.12] gh-108973: Fix asyncio test_subprocess_consistent_callbacks() (GH-109431) (#109609)
gh-108973: Fix asyncio test_subprocess_consistent_callbacks() (GH-109431)

SubprocessProtocol process_exited() method can be called before
pipe_data_received() and pipe_connection_lost() methods. Document it
and adapt the test for that.

Revert commit 282edd7b2a.
_child_watcher_callback() calls immediately _process_exited(): don't
add an additional delay with call_soon(). The reverted change didn't
make _process_exited() more determistic: it can still be called
before pipe_connection_lost() for example.

(cherry picked from commit ced6924630)

Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Davide Rizzo <sorcio@gmail.com>
2023-10-02 17:03:51 +02:00
Miss Islington (bot)
48afd1cf17
[3.12] GH-92584: Move installation schemes overview to sysconfig docs (GH-108018) (#110213)
GH-92584: Move installation schemes overview to sysconfig docs (GH-108018)

* Add new installation path functions subsection

* Add content from install/index to sysconfig

* Fix table

* Update note about installers

* Clean up the list of schemes, remove references to Distutils
(cherry picked from commit f16e81f368)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-10-02 10:50:28 +00:00
Miss Islington (bot)
b0a8cb2901
[3.12] gh-110138: Improve grammar in idiomatic usage of `__main__.py` (GH-110142) (#110188)
gh-110138: Improve grammar in idiomatic usage of ``__main__.py`` (GH-110142)
(cherry picked from commit adf0f15a06)

Co-authored-by: Quentin Agren <quentin.agren@gmail.com>
2023-10-02 12:03:12 +02:00
Hugo van Kemenade
96110e9429
[3.12] gh-101100: Fix sphinx warnings in library/site.rst (GH-110144) (#110187)
(cherry picked from commit 31097df611)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-10-02 12:02:29 +02:00
Miss Islington (bot)
54ffee0e51
[3.12] GH-101100: Fix reference warnings for `gettext` (GH-110115) (#110140)
GH-101100: Fix reference warnings for ``gettext`` (GH-110115)
(cherry picked from commit 0449fe999d)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-10-02 12:01:26 +02:00
Miss Islington (bot)
8882b30dab
[3.12] gh-109634: Fix :samp: syntax (GH-110073) (#110095)
gh-109634: Fix `:samp:` syntax (GH-110073)
(cherry picked from commit e27adc68cc)

Co-authored-by: Jacob Coffee <jacob@z7x.org>
2023-09-29 15:31:10 +02:00
Miss Islington (bot)
297104cce5
[3.12] gh-101100: Fix sphinx warnings in library/difflib.rst (GH-110074) (#110081)
gh-101100: Fix sphinx warnings in `library/difflib.rst` (GH-110074)
(cherry picked from commit d102d39bbe)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-09-29 15:29:14 +02:00
Miss Islington (bot)
69a9f47125
[3.12] gh-110045: Update symtable module for PEP 695 (GH-110066) (#110070)
gh-110045: Update symtable module for PEP 695 (GH-110066)
(cherry picked from commit 7dc2c5093e)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-09-29 08:10:22 +02:00
Miss Islington (bot)
2c557932e9
[3.12] gh-101100: Fix sphinx warnings in library/devmode.rst (GH-109963) (#109966)
gh-101100: Fix sphinx warnings in `library/devmode.rst` (GH-109963)
(cherry picked from commit d9809e84fb)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-09-27 17:38:42 +02:00
Hugo van Kemenade
57ff216215
[3.12] gh-101100: Fix Sphinx warnings in Doc/library/weakref.rst (GH-109881) (#109884)
[3.12] gh-101100: Fix Sphinx warnings in `Doc/library/weakref.rst` (GH-109881).
(cherry picked from commit 7c61a361fc)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-09-26 17:03:31 +02:00
Miss Islington (bot)
6f1d4552b3
[3.12] gh-101100: Fix sphinx warnings in Doc/library/xml.etree.elementtree.rst (GH-109799) (#109800)
gh-101100: Fix sphinx warnings in `Doc/library/xml.etree.elementtree.rst` (GH-109799)
(cherry picked from commit 649768fb67)


gh-101100: Fix shpinx warnings in `Doc/library/xml.etree.elementtree.rst`

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-09-24 13:55:28 +02:00
Miss Islington (bot)
2622b13046
[3.12] gh-109634: Use :samp: role (GH-109635) (#109776)
gh-109634: Use :samp: role (GH-109635)
(cherry picked from commit 92af0cc580)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-09-24 13:54:36 +02:00
Miss Islington (bot)
62df559448
[3.12] gh-100228: Document the os.fork threads DeprecationWarning. (GH-109767) (#109773)
* gh-100228: Document the os.fork threads DeprecationWarning. (GH-109767)

Document the `os.fork` posix threads detected `DeprecationWarning` in 3.12 What's New, os, multiprocessing, and concurrent.futures docs.

Many reviews and doc cleanup edits by Adam & Hugo. 🥳

(cherry picked from commit 5e7ea95d9d)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

* link to the discussion thread from whatsnew

Include the link to the discussion in the what's new text per @malemberg's comment on. https://github.com/python/cpython/pull/109767

(i'll follow up with a PR to main to include this edit there as well)

---------

Co-authored-by: Gregory P. Smith <greg@krypto.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-24 13:53:56 +02:00
Miss Islington (bot)
0015a9aad5
[3.12] Misc itertool recipe improvements, mostly docstrings and comments (gh-109555) (#109572)
(cherry picked from commit f2636d2c45)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2023-09-22 14:43:40 +02:00
Miss Islington (bot)
fbf703ce6e
[3.12] Fix extraneous backslashes in hashlib docs (GH-109468) (#109530)
Fix extraneous backslashes in hashlib docs (GH-109468)
(cherry picked from commit ce5b3e19e6)

Co-authored-by: Anthony Sottile <asottile@umich.edu>
2023-09-18 12:29:19 +02:00
Miss Islington (bot)
cc12f6684e
[3.12] gh-109451: Fix wrong format specifier in logging documentation (GH-109465) (#109483)
gh-109451: Fix wrong format specifier in logging documentation (GH-109465)
(cherry picked from commit 929cc4e4a0)

Co-authored-by: AlberLC <37489786+AlberLC@users.noreply.github.com>
2023-09-17 22:50:37 +02:00
Miss Islington (bot)
655287996e
[3.12] gh-109414: Add some basic information about venvs in the introduction. (GH-109440) (#109481)
gh-109414: Add some basic information about venvs in the introduction. (GH-109440)
(cherry picked from commit a6846d45ff)

Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Co-authored-by: Victor Stinner <vstinner@python.org>
2023-09-17 22:50:12 +02:00
Miss Islington (bot)
e9a90523c9
[3.12] Docs: Superseded modules: list only module names (GH-109439) (#109445)
Docs: Superseded modules: list only module names (GH-109439)
(cherry picked from commit b434dd7e36)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-15 16:11:17 +02:00