Commit Graph

12281 Commits

Author SHA1 Message Date
Miss Islington (bot) a10fc6670b
[3.11] gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst` (GH-111222) (#111470)
gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst` (GH-111222)

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

* Update Doc/library/socket.rst



* Update asyncio-eventloop.rst

* Update socket.rst

---------

(cherry picked from commit 46389c3275)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-29 19:39:25 +00:00
Miss Islington (bot) a9e0455bd3
[3.11] gh-111276: Clarify docs and comments about the role of LC_CTYPE (GH-111319) (#111392)
Fix locale.LC_CTYPE documentation to no longer mention string.lower() et al. Those functions were removed in Python 3.0:
https://docs.python.org/2/library/string.htmlGH-deprecated-string-functions

Also, fix a comment in logging about locale-specific behavior of `str.lower()`.

(cherry picked from commit 6d42759c5e)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-27 17:15:15 +02:00
Hugo van Kemenade e7cdcccd26
[3.11] gh-111187: Postpone removal version for locale.getdefaultlocale() to 3.15 (GH-111188) (#111326) 2023-10-27 16:08:53 +03:00
Miss Islington (bot) 07664c9ddb
[3.11] gh-108590: Improve sqlite3 docs on encoding issues and how to handle those (GH-108699) (#111325)
Add a guide for how to handle non-UTF-8 text encodings.
Link to that guide from the 'text_factory' docs.

(cherry picked from commit 1262e41842)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Corvin <corvin@corvin.dev>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-10-25 14:07:44 +00:00
Serhiy Storchaka fc9a5ef1a8
[3.11] [3.12] gh-111165: Move test running code from test.support to libregrtest (GH-111166) (GH-111316) (GH-111318)
Remove no longer used functions run_unittest() and run_doctest() from
the test.support module.
(cherry picked from commit f6a45a03d0)
(cherry picked from commit 5c4f9a1c7e)
2023-10-25 12:37:19 +00:00
Miss Islington (bot) ff7dc61643
[3.11] Revert "Fix a code snippet typo in asyncio docs (GH-108427)" (GH-111271) (GH-111273)
Revert "Fix a code snippet typo in asyncio docs (GH-108427)" (GH-111271)

This reverts commit 7f31676340.

The change resulted in a tautology and should not have been made.  There
may be an opportunity for additional clarity in this section, but this
change wasn't it :)

(cherry picked from commit c7d68f907a)


Ref: https://github.com/python/cpython/pull/108427#-issuecomment-1777525740

Co-authored-by: Zachary Ware <zach@python.org>
2023-10-24 11:26:57 -05:00
Jelle Zijlstra 575bff3732
[3.11] gh-111151: Convert monospaced directives to :ref: (GH-111152) (#111270)
(cherry picked from commit 1198076447)

Co-authored-by: InSync <122007197+InSyncWithFoo@users.noreply.github.com>
2023-10-24 15:34:46 +00:00
Miss Islington (bot) 10376a164f
[3.11] Fix typo in sys docs (GH-111196) (#111249)
Co-authored-by: James Tocknell <aragilar+github@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-24 08:15:03 +00:00
Miss Islington (bot) e35393fde9
[3.11] Fix a code snippet typo in asyncio docs (GH-108427) (#111244)
Co-authored-by: A <5249513+Dumeng@users.noreply.github.com>
2023-10-24 06:35:49 +00:00
Miss Islington (bot) bf41dcda70
[3.11] gh-101100: Fix Sphinx warnings for `fileno` (GH-111118) (#111227)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-23 19:18:00 +00:00
Miss Islington (bot) a449a70bcb
[3.11] typo: missing line of output in pull parser example (GH-111068) (#111218)
Co-authored-by: Don Patterson <37046246+don-patterson@users.noreply.github.com>
2023-10-23 16:04:52 +00:00
Miss Islington (bot) 135d5c5840
[3.11] gh-106310 - document the __signature__ attribute (GH-106311) (#111146)
Co-authored-by: Gouvernathor <44340603+Gouvernathor@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-10-23 18:49:17 +03:00
Miss Islington (bot) aaa755dd48
[3.11] gh-101100: Fix sphinx warnings in `library/asyncio-dev.rst` (GH-111179) (#111186)
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:29:06 -07:00
Miss Islington (bot) 6df935c212
[3.11] gh-101100: Fix sphinx warnings in `library/codecs.rst` (GH-110979) (#111071)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-20 11:09:23 +03:00
Miss Islington (bot) f1dbde0d3a
[3.11] gh-101100: Fix Sphinx warnings in `library/tty.rst` (GH-111079) (#111098)
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:50:17 +03:00
Miss Islington (bot) 2b3f9a5a1d
[3.11] gh-109510: Clearly explain "Which Docstrings Are Examined" (GH-109696) (#111078)
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:07 +03:00
Miss Islington (bot) f22cdecb19
[3.11] GH-101100: Fix reference warnings for ``__enter__`` and ``__exit__`` (GH-110112) (#111076)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-10-19 18:34:27 +03:00
Miss Islington (bot) 1b60244b97
[3.11] GH-101100: Fix reference warnings for ``__getitem__`` (GH-110118) (#111074)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-10-19 18:33:12 +03:00
Miss Islington (bot) 4fc5352a0d
[3.11] gh-101100: Fix sphinx warnings in `library/getpass.rst` (GH-110461) (#111072)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-10-19 18:31:29 +03:00
Miss Islington (bot) faa7c207bf
[3.11] GH-104232: Fix statement about trace return values (GH-111045)
(cherry picked from commit d9246c7b73)
2023-10-18 20:34:20 +00:00
Miss Islington (bot) 44558a9ba8
[3.11] gh-101100: Fix sphinx warnings in `library/time.rst` (GH-110862) (#110878)
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:23 +00:00
Miss Islington (bot) c0a77eb442
[3.11] gh-110703: Add asyncio.wait_for() change notes for 3.11 (GH-110818) (#110827)
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:29 +00:00
Ezio Melotti 90b2620b6e
[3.11] gh-110631: Fix reST indentation (GH-110724) (#110739)
* Fix wrong indentation in the other dirs.

* Fix more wrong indentation..
(cherry picked from commit 718391f475)
2023-10-11 23:12:53 +02:00
Ezio Melotti 07471cda29
[3.11] gh-110631: Fix reST indentation in `Doc/library` (GH-110685) (#110737)
* [3.11] 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>

* Fix merge glitch.
2023-10-11 23:11:41 +02:00
Hugo van Kemenade fd061a9bbe
[3.11] gh-108826: Document `dis` module CLI and rename `_test` function to `main` (#108827) (#110689)
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:48:03 -06:00
Miss Islington (bot) de62c2c1b3
[3.11] gh-101100: Fix sphinx warnings in `library/socketserver.rst` (GH-110207) (GH-110624)
(cherry picked from commit 756062b296)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-10-10 14:10:33 +02:00
Miss Islington (bot) 6b63d40919
[3.11] gh-110497: Add note about `OSError` being an alias to `IOError` in docs (GH-110498) (#110545)
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:01 +02:00
Miss Islington (bot) 3d5aa7ec61
[3.11] Fix typo in Doc/library/textwrap.rst (GH-110328) (#110474)
Co-authored-by: InSync <122007197+InSyncWithFoo@users.noreply.github.com>
2023-10-06 14:35:23 +00:00
Miss Islington (bot) a55c203104
[3.11] gh-110383: Swap 'the all' -> 'all the' in socket docs (GH-110434) (#110436)
Co-authored-by: Bradley Reynolds <bradley.reynolds@darbia.dev>
2023-10-05 14:14:32 -06:00
Adam Turner 8394368f1f
[3.11] Docs: Avoid the deprecated ``.. cmdoption::`` directive (GH-110292) (#110303)
[3.11] Docs: Avoid the deprecated ``.. cmdoption::`` directive (GH-110292).
(cherry picked from commit 77e9aae383)
2023-10-05 20:30:26 +03:00
Miss Islington (bot) 6a6081f820
[3.11] gh-110383 TimeIt Docs Spelling Fix (GH-110407) (#110410)
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:10:39 +00:00
Victor Stinner f9ac377626
[3.11] Add test.support.busy_retry() (#93770) (#110341)
Add test.support.busy_retry() (#93770)

Add busy_retry() and sleeping_retry() functions to test.support.

(cherry picked from commit 7e9eaad864)
2023-10-04 12:58:49 +02:00
Miss Islington (bot) 6a6e8871ba
[3.11] 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:04 +00:00
Miss Islington (bot) bf6843e91f
[3.11] [3.12] gh-109649: Enhance os.cpu_count() documentation (GH-110169) (#110226)
[3.12] gh-109649: Enhance os.cpu_count() documentation (GH-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
(cherry picked from commit 5245b97e13)

Co-authored-by: Victor Stinner <vstinner@python.org>
2023-10-02 18:36:55 -07:00
Miss Islington (bot) 0914b13ba5
[3.11] gh-110138: Improve grammar in idiomatic usage of ``__main__.py`` (GH-110142) (#110189)
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-01 20:32:44 +01:00
Miss Islington (bot) 00da3ccd0a
[3.11] gh-101100: Fix sphinx warnings in `library/site.rst` (GH-110144) (#110185)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-10-01 11:47:06 -06:00
Miss Islington (bot) cb1f49991e
[3.11] GH-101100: Fix reference warnings for ``gettext`` (GH-110115) (#110141)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-09-30 11:21:27 +00:00
Hugo van Kemenade 6bc722df2e
[3.11] gh-101100: Fix sphinx warnings in `library/difflib.rst` (GH-110074) (#110082)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-09-29 11:19:34 +03:00
Serhiy Storchaka c534637106
[3.11] gh-109634: Use :samp: role (GH-109635) (GH-109778)
(cherry picked from commit 92af0cc580)

Co-authored-by: Jacob Coffee <jacob@z7x.org>
2023-09-29 09:39:31 +03:00
Miss Islington (bot) 38526a29ed
[3.11] Enhance TypedDict docs around required/optional keys (GH-109547) (#109983)
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-09-27 10:54:27 -07:00
Miss Islington (bot) cb0f41f232
[3.11] gh-101100: Fix sphinx warnings in `library/devmode.rst` (GH-109963) (#109967)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-09-27 17:16:01 +03:00
Miss Islington (bot) 3ab0621db7
[3.11] gh-101100: Fix Sphinx warnings in `Doc/library/weakref.rst` (GH-109881) (#109883)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-09-26 10:58:59 +03:00
Miss Islington (bot) e6a9cbd114
[3.11] gh-101100: Fix sphinx warnings in `Doc/library/xml.etree.elementtree.rst` (GH-109799) (#109801)
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 10:02:07 +00:00
Alex Waygood a023de65fc
[3.11] Fix typos in docs and comments (#109619) (#109622)
Co-authored-by: Heinz-Alexander Fuetterer <35225576+afuetterer@users.noreply.github.com>
2023-09-20 17:50:48 +00:00
Victor Stinner 336dbe56b2
[3.11] gh-108973: Fix asyncio SubprocessProtocol doc (#109431) (#109610)
gh-108973: Fix asyncio SubprocessProtocol doc (#109431)

SubprocessProtocol process_exited() method can be called before
pipe_data_received() and pipe_connection_lost() methods. Document it
and adapt the example in the doc.

Co-authored-by: Davide Rizzo <sorcio@gmail.com>
(cherry picked from commit ced6924630)
2023-09-20 14:15:08 +00:00
Miss Islington (bot) 355a5cd262
[3.11] Fix extraneous backslashes in hashlib docs (GH-109468) (#109531)
Fix extraneous backslashes in hashlib docs (GH-109468)
(cherry picked from commit ce5b3e19e6)

Co-authored-by: Anthony Sottile <asottile@umich.edu>
2023-09-18 07:34:20 +00:00
Miss Islington (bot) 9b38cbee90
[3.11] gh-109451: Fix wrong format specifier in logging documentation (GH-109465) (GH-109482)
(cherry picked from commit 929cc4e4a0)
2023-09-16 15:39:06 +01:00
Miss Islington (bot) e16a9af1cd
[3.11] gh-109414: Add some basic information about venvs in the introduction. (GH-109440) (GH-109480)
(cherry picked from commit a6846d45ff)
2023-09-16 11:14:07 +01:00
Miss Islington (bot) 5a2550554b
[3.11] Docs: Superseded modules: list only module names (GH-109439) (#109446)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-15 16:10:07 +03:00
Miss Islington (bot) 8e23cd0bbb
[3.11] gh-101100: Fix sphinx warnings in `turtle.rst` (GH-109394) (#109417)
(cherry picked from commit 21e80f4c19)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-09-14 14:41:26 -04:00