Commit graph

26502 commits

Author SHA1 Message Date
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)
a151afe719
[3.11] Bump various dependencies in Doc/requirements-oldest-sphinx.txt (GH-110278) (#110281)
Bump various dependencies in `Doc/requirements-oldest-sphinx.txt` (GH-110278)

This resolves a Dependabot security alert on the repository for urllib3==2.0.4.
(cherry picked from commit f1663a492e)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-10-03 13:18:08 +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)
2c79a3fe00
[3.11] Docs: bump Pygments to fix contrast ratios to meet WCAG AA guidelines (GH-110208) (#110211)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-02 10:42:57 +00: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
Miss Islington (bot)
a673248d6c
[3.11] GH-101100: Fix reference warnings for `namedtuple` (GH-110113) (#110136)
GH-101100: Fix reference warnings for ``namedtuple`` (GH-110113)
(cherry picked from commit cbdacc738a)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-09-30 06:42:37 +00:00
Adam Turner
d81bcc2327
[3.11] gh-102304: Add links to the Stable ABI and Limited C API docs (#105345) (#105371) (#109901)
* Add "limited-c-api" and "stable-api" targets
* Rename the "stable-abi-list" target to "limited-api-list"
2023-09-29 11:17:44 +02:00
Miss Islington (bot)
6024a75b10
[3.11] gh-101100: Fix references to `URLError and HTTPError in howto/urllib2.rst` (GH-107966) (#110087)
Co-authored-by: Yuki K <drsuaimqjgar@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-29 08:44:28 +00:00
Miss Islington (bot)
58ac0ed093
[3.11] gh-101100: Fix Sphinx warnings in tutorial/controlflow.rst (GH-109424) (#110085)
Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-09-29 08:36:24 +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
Victor Stinner
d951aaea97
[3.11] gh-107298: Document PyMODINIT_FUNC macro (#109236) (#109948)
gh-107298: Document PyMODINIT_FUNC macro (#109236)

Document PyMODINIT_FUNC macro.

Remove links to PyAPI_FUNC() and PyAPI_DATA() macros since they are
not documented. These macros should only be used to define the Python
C API. They should not be used outside Python code base.

(cherry picked from commit d7a27e527d)
2023-09-27 10:40:24 +02:00
Miss Islington (bot)
c485715ba8
[3.11] gh-101100: Fix Sphinx warnings in Doc/using/configure.rst (GH-109931) (#109938)
gh-101100: Fix Sphinx warnings in Doc/using/configure.rst (GH-109931)
(cherry picked from commit 3538930d87)

Co-authored-by: Victor Stinner <vstinner@python.org>
2023-09-27 02:35:26 +02: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
Miss Islington (bot)
4ec7c7e845
[3.11] GH-95913: Add the release date for Python 3.11 (GH-109750) (#109772)
GH-95913: Add the release date for Python 3.11 (GH-109750)
(cherry picked from commit b10de68c6c)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-09-22 21:19:22 -07:00
Hugo van Kemenade
cbe153edd6
[3.11] Docs: Update Donghee Na's name (GH-109743) (#109759)
* Update Donghee Na's name in Docs/

* Update Donghee Na's name in Misc/ACKS

* Update Donghee Na's name in Misc/NEWS.d/
2023-09-23 06:53:47 +03:00
Miss Islington (bot)
e918b19f42
[3.11] GH-109209: Bump the minimum Sphinx version to 4.2 (GH-109210) (#109637)
GH-109209: Bump the minimum Sphinx version to 4.2 (GH-109210)
(cherry picked from commit 712cb173f8)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-09-21 06:32:10 +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)
7cabbb133a
[3.11] gh-109474: Update two Unix packaging URLs (GH-109307) (#109478)
gh-109474: Update two Unix packaging URLs  (GH-109307)

update packaging URLs

fix a broken URL for fedora RPM packaging guide and fix a URL redirect for Slackware packaging guide.
(cherry picked from commit 0b38ce440b)

Co-authored-by: partev <petrosyan@gmail.com>
2023-09-16 07:56:16 +00: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
Miss Islington (bot)
2a24328db5
[3.11] GH-104395: Add a link in 'Meta Information' to the docs download page (GH-104443) (#109346)
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-12 20:41:39 +00:00
Irit Katriel
5681cd1a9d
[3.11] gh-109184: update traceback module doc w.r.t notes (message is no longer always at the end) (#109201) (#109336)
gh-109184: update traceback module doc w.r.t notes (message is no longer always at the end) (#109201)

(cherry picked from commit 0e76cc359b)
2023-09-12 18:08:38 +01:00
Miss Islington (bot)
0e2d67457b
[3.11] gh-107322: zipapp: Remove the suggestion to remove .dist-info directories (GH-107296) (#109282)
Co-authored-by: wim glenn <hey@wimglenn.com>
2023-09-11 23:53:15 -06:00
Hugo van Kemenade
77356f6f96
[3.11] gh-107924: re-order os.sendfile() flag documentation (#107926) (#109178)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
2023-09-09 03:34:18 -06:00
Ethan Furman
effa2ecdcf
[3.11] gh-108682: [Enum] raise TypeError if super().__new__ called in custom __new__ (GH-108704) (GH-108739)
When overriding the `__new__` method of an enum, the underlying data type should be created directly; i.e. .

    member = object.__new__(cls)
    member = int.__new__(cls, value)
    member = str.__new__(cls, value)

Calling `super().__new__()` finds the lookup version of `Enum.__new__`, and will now raise an exception when detected.

(cherry picked from commit d48760b2f1)
2023-09-07 18:57:48 -07:00
Miss Islington (bot)
d9d64a4a13
[3.11] gh-102823: Document return type of floor division on floats (GH-102824) (#109093)
Co-authored-by: Mark Dickinson <dickinsm@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-07 14:34:30 +00:00
Miss Islington (bot)
297006b6f8
[3.11] gh-71770: Add more details on behavior of configparser's default_section (GH-31562) (#109089)
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-07 14:03:20 +00:00
Miss Islington (bot)
417a7b5b10
[3.11] GH-90915: Document that SystemExit doesn't trigger sys.excepthook (GH-31357) (#109083)
Co-authored-by: Colin Watson <cjwatson@debian.org>
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-07 13:23:08 +00:00
Miss Islington (bot)
cccb81d294
[3.11] socket documentation fix - rename triple to 3-tuple (GH-24722) (#109074)
Co-authored-by: Ori Hoch <ori@uumpa.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-07 13:44:35 +03:00
Miss Islington (bot)
f6d70e9a18
[3.11] bpo-38157: Add example about per file output for mock_open. (GH-16090) (#109072)
Co-authored-by: Karthikeyan Singaravelan <tir.karthi@gmail.com>
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-07 12:32:28 +03:00
Miss Islington (bot)
1f115a8822
[3.11] gh-107755: Document the correct default value of slice step (GH-107756) (#108956)
gh-107755: Document the correct default value of slice step (GH-107756)

Document the correct default value of slice step.
(cherry picked from commit 9bf350b066)

Co-authored-by: wim glenn <hey@wimglenn.com>
2023-09-07 02:11:53 +02:00
Miss Islington (bot)
5fbd77165b
[3.11] GH-108202: Document `calendar`'s command-line interface (GH-109020) (#109031)
GH-108202: Document ``calendar``'s command-line interface (GH-109020)
(cherry picked from commit f0f96a9f40)

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-07 02:11:06 +02:00
Miss Islington (bot)
2ef888d250
[3.11] gh-108857: improve markup in inspect.Signature.replace() docs (GH-108862) (#108970)
gh-108857: improve markup in inspect.Signature.replace() docs (GH-108862)
(cherry picked from commit 6f8411cfd6)

Co-authored-by: nabin2004 <107109731+nabin2004@users.noreply.github.com>
2023-09-06 00:39:09 +00:00
Nikita Sobolev
662d236be2
[3.11] gh-101100: Fix sphinx warnings in unittest.mock-examples.rst (GH-108810) (#108812)
(cherry picked from commit 5141b1ebe0)
2023-09-02 13:38:59 +00:00
Miss Islington (bot)
fa8b9c147d
[3.11] gh-101100: Fix sphinx warnings in uuid.rst (GH-108805) (#108808)
(cherry picked from commit 21da4980f5)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-09-02 07:05:07 -06:00
Serhiy Storchaka
6538bcfa0b
[3.11] Improve some C API documentation (GH-108768) (GH-108786)
* Express functions which take argument as a C string in terms of
  functions which take Python object.
* Use "note" directive for PyMapping_HasKey() and
  PyMapping_HasKeyString() notes.

(cherry picked from commit 6f97eeec22)
2023-09-02 07:30:32 +03:00