Commit graph

26461 commits

Author SHA1 Message Date
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
Miss Islington (bot)
0701f8cabd
[3.11] gh-105563: reference DateType in datetime's documentation (GH-105946) (#108790)
gh-105563: reference DateType in datetime's documentation (GH-105946)
(cherry picked from commit 8f9ea43ee8)

Co-authored-by: TATHAGATA ROY <royzen9495@gmail.com>
2023-09-01 20:46:21 +00:00
Miss Islington (bot)
d3476dcb84
[3.11] gh-101100: Fix sphinx warnings in tutorial/appendix.rst (GH-108750) (#108757)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-01 15:09:43 +03:00
Miss Islington (bot)
3b14346899
[3.11] gh-101100: Fix sphinx warnings in tutorial/classes.rst (GH-108746) (#108755)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-09-01 10:57:30 +00:00
Gregory P. Smith
6ba1234c1c
[3.11] gh-104372: Drop the GIL around the vfork() call. (#104782) (#104958)
gh-104372: Drop the GIL around the vfork() call. (#104782)

On Linux where the `subprocess` module can use the `vfork` syscall for
faster spawning, prevent the parent process from blocking other threads
by dropping the GIL while it waits for the vfork'ed child process `exec`
outcome.  This prevents spawning a binary from a slow filesystem from
blocking the rest of the application.

Fixes #104372.

(cherry picked from commit d08679212d)
2023-09-01 08:53:06 +00:00
Miss Islington (bot)
b4784b0c5f
[3.11] ast docs: Fix incorrect link on keyword (GH-108728) (#108738)
`ast` docs: Fix incorrect link on `keyword` (GH-108728)

In two places, Sphinx was erroneously adding links to the `keyword` module instead of the `ast.keyword` class
(cherry picked from commit c1e2f3b2f7)

Co-authored-by: Alex Povel <git@alexpovel.de>
2023-08-31 22:27:27 +00:00
Miss Islington (bot)
e93f57208f
[3.11] gh-101100: Fix sphinx warnings in threading.rst (GH-108684) (#108708)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-31 11:28:47 +03:00
Miss Islington (bot)
f8ab9751da
[3.11] gh-101100: Fix Sphinx warnings in the Logging Cookbook (GH-108678) (#108681)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-30 15:19:44 +03:00
Miss Islington (bot)
d06aaff19d
[3.11] Fix typo in multiprocessing docs (GH-108666) (#108676)
Fix typo in multiprocessing docs (GH-108666)
(cherry picked from commit 38ab0dba80)

Co-authored-by: kato8966 <66937409+kato8966@users.noreply.github.com>
2023-08-30 11:17:23 +00:00
Miss Islington (bot)
a2c05a414d
[3.11] Mention Ellipsis pickling in the docs (GH-103660) (#108662)
Mention Ellipsis pickling in the docs (GH-103660)
(cherry picked from commit 14ec0bb7c3)

Co-authored-by: sterliakov <50529348+sterliakov@users.noreply.github.com>
2023-08-29 23:04:42 -07:00
Erlend E. Aasland
d79216d48f
[3.11] gh-107801: Improve the accuracy of io.IOBase.seek docs (#108268) (#108656)
(cherry picked from commit 8178a88bd8)

- Add param docstrings
- Link to os.SEEK_* constants
- Mention the return value in the initial paragraph

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-29 19:57:49 +00:00
Alex Waygood
b1ed10f413
[3.11] Fix misc doc typos (GH-108592) (#108613)
(cherry picked from commit 88f1c5b)

Co-authored-by: xzmeng <aumo@foxmail.com>
2023-08-29 08:56:14 +00:00
Miss Islington (bot)
c19713d4a1
[3.11] Fix typo in typing docs: Remove redundant backtick (GH-108559) (#108561)
Fix typo in typing docs: Remove redundant backtick (GH-108559)
(cherry picked from commit 72b615ab01)

Co-authored-by: nikkie <takuyafjp+develop@gmail.com>
2023-08-28 11:28:19 +00:00
Erlend E. Aasland
bd951cd95b
[3.11] gh-107801: Document io.TextIOWrapper.tell (#108265) (#108548)
(cherry picked from commit 38afa4af9b)
2023-08-27 21:22:43 +00:00
Miss Islington (bot)
c8e66c47da
[3.11] Fix grammatical error in stringprep documentation (GH-108414) (#108538)
Fix grammatical error in stringprep documentation (GH-108414)

Remove the word "them", which didn't make grammatical sense.

(cherry picked from commit cd0a8aece9)

Co-authored-by: Matthew James Kraai <kraai@ftbfs.org>
Co-authored-by: KRAAI, MATTHEW [VISUS] <mkraai@its.jnj.com>
2023-08-27 14:12:51 +01:00
Miss Islington (bot)
8a275f7c01
[3.11] gh-105052:update timeit function's description (GH-105060) (#108535)
---------
Co-authored-by: Terry Jan Reedy tjreedy@udel.edu
Co-authored-by: R <cherrymelon@foxmail.com>
(cherry picked from commit 7096a2be33)
2023-08-27 03:57:32 -04:00
Miss Islington (bot)
a44dcfde18
[3.11] gh-107453: Document errno.{ECANCELED,EOWNERDEAD,ENOTRECOVERABLE,ENOTSUP} (GH-107486) (#108530)
Co-authored-by: qqwqqw689 <114795525+qqwqqw689@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-26 23:33:23 -06:00
Miss Islington (bot)
af13f0e91b
[3.11] gh-102211: Document re.{Pattern,Match}’s existence (GH-102212) (#108491)
Co-authored-by: Philipp A <flying-sheep@web.de>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-08-25 11:28:56 -06:00
Miss Islington (bot)
cc81f5b61a
[3.11] [3.12] gh-108314: PyDict_GetItemString() mentions UTF-8 (GH-108448) (#108489)
[3.12] gh-108314: PyDict_GetItemString() mentions UTF-8 (GH-108448)

gh-108314: PyDict_GetItemString() mentions UTF-8

PyDict_GetItemString(), PyDict_SetItemString() and
PyDict_DelItemString() expects a UTF-8 encoding string for the key.
(cherry picked from commit 9a225d7d5b)

Co-authored-by: Victor Stinner <vstinner@python.org>
2023-08-25 18:48:25 +02:00
Adam Turner
5505bfd687
[3.11] Datamodel: Add headings to the standard type hierarchy (GH-108146) (#108484)
* [3.11] Datamodel: Add headings to the standard type hierarchy (GH-108146)

Dedent content according to the new layout..
(cherry picked from commit 2b7bff0655)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

* Fix indentation
2023-08-25 18:27:34 +03:00
Miss Islington (bot)
8cf3cae8c5
[3.11] Docs: Datamodel: Merge "Notes on using __slots__" with the parent section (GH-108400) (#108475)
(cherry picked from commit 7f5b1a0661)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-25 13:04:00 +02:00
Miss Islington (bot)
ee61f7db31
[3.11] GH-108202: Document `calendar` exceptions (GH-108398) (#108468)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-25 06:06:34 +00:00
Miss Islington (bot)
42f9d6faa2
[3.11] gh-107432 Update Porting Python 2 Code to Python 3 how-to (GH-107434) (#108410)
https://docs.python.org/3/howto/pyporting.html was written for another time. In this patch:

- material that frames Python 3 as "new" is removed
- descriptions and directions have been trimmed
(cherry picked from commit 809ea7c4b6)

Co-authored-by: Daniele Procida <daniele@vurt.org>
2023-08-24 13:26:56 +02:00
Miss Islington (bot)
869dc14a2e
[3.11] gh-70766: Mention the object getstate caveat in 3.11 What's new. (GH-108379) (#108385)
gh-70766: Mention the object getstate caveat in 3.11 What's new. (GH-108379)
(cherry picked from commit b6be18812c)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2023-08-23 22:10:27 +00:00
Miss Islington (bot)
07c727e92a
[3.11] gh-107136: Remove Plausible for docs metrics (GH-107856) (#108335)
(cherry picked from commit fc23f34cc9)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-23 11:01:30 +02:00
Miss Islington (bot)
1ecbe787dd
[3.11] gh-108267: Dataclasses docs: Fix object.__setattr__ typo (GH-108355) (#108357)
gh-108267: Dataclasses docs: Fix object.__setattr__ typo (GH-108355)

Fixed a sentence in dataclasses.rst

Changed "__setattr__" to "object.__setattr__" in a section that was specifically supposed to refer to the __setattr__ method of the object class. Also suppressed the link to the data model docs for __setattr__, since we're talking about a specific __setattr__ implementation, not __setattr__ methods in general.
(cherry picked from commit 79fdacc005)

Co-authored-by: FrozenBob <30644137+FrozenBob@users.noreply.github.com>
2023-08-23 07:20:57 +00:00
Miss Islington (bot)
12cad6155b
[3.11] Docs: Add link to skip to datetime's format codes (GH-108027) (#108330)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-22 13:52:51 -06:00
Miss Islington (bot)
fadf8a032b
[3.11] Clarify how topics.py gets created. (GH-106121) (GH-106580)
When changing docs, it was easy to find text in topics.py, and I
wondered whether I was supposed to edit it.  Thankfully, the top of the
file says it's auto-generated, so I knew I didn't have to edit it. But I
didn't know what started the auto-generation process.

It's part of the release process, so I'll leave a note here for future
editors.
(cherry picked from commit dac1e36490)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2023-08-22 19:23:55 +00:00
Miss Islington (bot)
9d7f2705b5
[3.11] gh-107700: [Enum] Document that EnumType was added in 3.11 (GH-108260) (#108300)
(cherry picked from commit e8ef0bdd8c)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-08-22 20:33:26 +02:00
Serhiy Storchaka
3ca9264aba
[3.11] gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258) (#108290)
(cherry picked from commit d7202e4879)
2023-08-22 20:33:07 +02:00
Miss Islington (bot)
80c7ae00f1
[3.11] gh-107298: Fix C API datetime documentation (GH-108034) (#108233)
(cherry picked from commit d63972e289)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-08-22 20:32:48 +02:00
Miss Islington (bot)
3a39e15179
[3.11] Resolve reference warnings in faq/gui.rst (GH-108147) (#108194)
(cherry picked from commit 8f3d09bf5d)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-22 20:32:16 +02:00
Miss Islington (bot)
d22ac0c605
[3.11] Docs: align the param spec of sqlite3.Connection methods with the implementation (GH-108285) (#108288)
- no parameters of create_aggregate() are positional-only
- all parameters of create_collation() are positional-only
(cherry picked from commit 893215a4e7)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-08-22 13:28:38 +00:00
Hugo van Kemenade
9d00379e2c
[3.11] Docs: move sphinx-lint to pre-commit (GH-105750) (#108276) 2023-08-22 15:18:39 +03:00
Miss Islington (bot)
8e837373ed
[3.11] gh-107845: Fix symlink handling for tarfile.data_filter (GH-107846) (GH-108209)
gh-107845: Fix symlink handling for tarfile.data_filter (GH-107846)

(cherry picked from commit acbd3f9c5c)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Lumír 'Frenzy' Balhar <frenzy.madness@gmail.com>
2023-08-22 10:51:58 +02:00
Erlend E. Aasland
cc42182c97
[3.11] gh-107801: Improve the accuracy of io.TextIOWrapper.seek docs (#107933) (#108264)
(cherry picked from commit 7f87ebbc3f)

Clearly document the supported seek() operations:

- Rewind to the start of the stream
- Restore a previous stream position (given by tell())
- Fast-forward to the end of the stream
2023-08-22 08:19:56 +00:00
Miss Islington (bot)
4d4871e715
[3.11] gh-108224: Fix asyncio doc inconsistency (GH-108230) (#108232)
(Spawning subprocesses does not require the event loop to run in the main thread -- only signal handling does.)

(cherry picked from commit 1cc391d9e2)

Co-authored-by: temach <tematibr@gmail.com>
2023-08-21 14:21:26 -07:00
Miss Islington (bot)
145d9252b7
[3.11] gh-107298: Fix references to deprecated and removed PyUnicode C API (GH-108077) (GH-108226)
(cherry picked from commit db55383829)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-08-21 20:35:36 +03:00
Serhiy Storchaka
be99653080
[3.11] Improve references in the tutorial (GH-108069) (GH-108204)
* Use full qualified names for references (even if they do not work now,
  they will work in future).
* Silence references to examples.
(cherry picked from commit 622ddc4167)
2023-08-21 10:53:36 +00:00
Miss Islington (bot)
a372274a9b
[3.11] Docs: document 'manager' and '_log' attrs of logging.Logging (GH-108145) (GH-108189)
(cherry picked from commit f904aa4e1f)
Authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-08-21 11:44:25 +01:00
Miss Islington (bot)
4be05aab33
[3.11] Resolve reference warnings in faq/library.rst (GH-108149) (#108183)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-20 13:26:01 -06:00
Adam Turner
ff82da17b6
[3.11] Resolve reference warnings in faq/design.rst (GH-108148) (#108181) 2023-08-20 18:56:14 +00:00