Commit graph

12348 commits

Author SHA1 Message Date
Miss Islington (bot)
478da38e74
[3.11] gh-74573: document that ndbm can silently corrupt databases on macOS (GH-113354) (#113432)
gh-74573: document that ndbm can silently corrupt databases on macOS (GH-113354)

* gh-74573: document that ndbm can silently corrupt databases on macOS

The system ndbm implementation on macOS has an undocumented limitation
on the size of values and can silently corrupt database files when those
are exceeded.

(cherry picked from commit 593b4d81d2)

Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2023-12-23 13:49:58 +01:00
Miss Islington (bot)
0bd134d15f
[3.11] gh-112925: Fix error in example of datetime.time.fromisoformat and add doctest marker (GH-112931) (GH-113428)
(cherry picked from commit bdc8d667ab)

Co-authored-by: F-park <52167622+F-park@users.noreply.github.com>
2023-12-23 10:50:19 +00:00
Miss Islington (bot)
4baa4b519a
[3.11] Docs: OpenSSL wording ambiguity (GH-113296) (#113349)
Co-authored-by: Jan Brasna <1784648+janbrasna@users.noreply.github.com>
2023-12-21 07:56:34 +00:00
Alex Waygood
d65dfc8238
[3.11] gh-113255: Clarify docs for typing.reveal_type (#113286) (#113326)
(cherry-picked from commit 11ee912327)

Co-authored-by: Kir <note351@hotmail.com>
2023-12-20 18:35:13 +00:00
Miss Islington (bot)
f1c27bebb2
[3.11] Fix typo in collections.abc docs example (GH-113310) (#113312)
Fix typo in collections.abc docs example (GH-113310)

Calling the instance reference arg for the __next__ method, "next", seems misleading as it would normally just be "self"
(cherry picked from commit 22b8945d76)

Co-authored-by: David Greaves <david@dgreaves.com>
2023-12-20 09:57:25 +00:00
Hugo van Kemenade
182676beba
[3.11] gh-101100: Fix Sphinx warnings in library/ast.rst (GH-113289) (#113291) 2023-12-19 18:12:33 +02:00
Miss Islington (bot)
208c95bffe
[3.11] gh-113234: tomllib docs: reorder conversion table & add remaining types (GH-113236) (GH-113284)
gh-113234: tomllib docs: reorder conversion table & add remaining types (GH-113236)
(cherry picked from commit 76d757b38b)

Co-authored-by: ryan-duve <ryan-duve@users.noreply.github.com>
2023-12-19 10:36:01 +00:00
Hugo van Kemenade
bd8aa9d8bd
[3.11] gh-101100: Fix Sphinx warnings in library/tarfile.rst (GH-113237) (#113245) 2023-12-18 07:12:52 +00:00
Miss Islington (bot)
b0b7fee7cb
[3.11] gh-112890: unittest Test Discovery page updated "unittest dropped the namspace packages support" (GH-113195) (GH-113229)
(cherry picked from commit 21d52995ea)

Co-authored-by: Taylor Packard <3.t.packard@gmail.com>
2023-12-17 11:20:28 +00:00
Ronald Oussoren
11401e2c79
[3.11] gh-105912: document gotcha with using os.fork on macOS (GH-112871) (#113135)
* gh-105912: document gotcha with using os.fork on macOS

Using ``fork(2)`` on macOS when also using higher-level
system APIs in the parent proces can crash on macOS because
those system APIs are not written to handle this usage
pattern.

There's nothing we can do about this other than documenting
the problem.

(cherry picked from commit 22511f77c2)

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2023-12-16 10:13:01 +01:00
Miss Islington (bot)
2be7a7296f
[3.11] gh-113046: Revise csv.reader doc (GH-113207) (#113211)
Clarify nature of csvfile.
(cherry picked from commit 84df3172ef)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-12-16 08:18:45 +00:00
Miss Islington (bot)
a7a176de07
[3.11] gh-110746: Improve markup in `tkinter.ttk.rst` (GH-111236) (#113194)
gh-110746: Improve markup in ``tkinter.ttk.rst`` (GH-111236)

* gh-110746: Improve markup in tkinter.ttk.rst

* gh-110746: Improve markup in tkinter.ttk.rst

* 📜🤖 Added by blurb_it.

---------

(cherry picked from commit 00d2b6d1fc)

Co-authored-by: Akshat Khandelwal <35228810+akshatgokul@users.noreply.github.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-12-15 22:56:36 +01:00
Miss Islington (bot)
bbc70451e0
[3.11] gh-101100: Fix various Sphinx warnings for dunder references in the library/ directory (GH-113163) (#113184)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-15 17:21:59 +00:00
Miss Islington (bot)
740d5da5d9
[3.11] gh-101100: Fix Sphinx nitpicks in library/numbers.rst (GH-113162) (#113181)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-15 19:17:14 +02:00
Miss Islington (bot)
811972e2fd
[3.11] gh-101100: Fix Sphinx nitpicks in library/rlcompleter.rst (GH-113125) (#113159)
gh-101100: Fix Sphinx nitpicks in `library/rlcompleter.rst` (GH-113125)
(cherry picked from commit 7bb00f053e)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-15 09:07:15 +00:00
Hugo van Kemenade
a056aabbc7
[3.11] gh-101100: Cleanup mailbox docs (GH-113124) (#113145)
(cherry picked from commit 25061f5c98)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-14 21:26:49 +00:00
Miss Islington (bot)
ba6958522d
[3.11] gh-101100: Fix Sphinx nitpicks in library/collections.abc.rst (GH-113116) (#113137)
gh-101100: Fix Sphinx nitpicks in `library/collections.abc.rst` (GH-113116)
(cherry picked from commit 006355b2a9)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-14 19:32:37 +00:00
Miss Islington (bot)
99c8d16cff
[3.11] gh-101100: Fix Sphinx nitpicks in library/traceback.rst (GH-113106) (#113112)
gh-101100: Fix Sphinx nitpicks in `library/traceback.rst` (GH-113106)
(cherry picked from commit d9e1b5794a)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-14 14:17:13 +00:00
Miss Islington (bot)
e0c6995b4f
[3.11] Fixing typo in DocTestRunner docs (GH-112326) (GH-113098)
(cherry picked from commit b3c21265fa)

Co-authored-by: Daniel Wysocki <dwysocki@users.noreply.github.com>
2023-12-14 10:15:43 +00:00
Miss Islington (bot)
694631ca14
[3.11] gh-107959: clarify Unix-availability of os.lchmod() (GH-107960) (GH-113067)
gh-107959: clarify Unix-availability of `os.lchmod()` (GH-107960)

POSIX specifies that implementations are not required to support changing the
file mode of symbolic links, but may do so.
Consequently, `lchmod()` is not part of POSIX (but mentioned for implementations
which do support the above).

The current wording of the availability of `os.lchmod()` is rather vague and
improved to clearly tell which POSIX/Unix/BSD-like support the function in
general (those that support changing the file mode of symbolic links).
Further, some examples of major implementations are added.

Data for the BSDs taken from their online manpages.

(cherry picked from commit f14e3d59c9)

Signed-off-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
Co-authored-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-12-13 20:02:07 +00:00
Miss Islington (bot)
f35322502a
[3.11] [doc] Make subprocess.wait documentation more precise (GH-98700) (#112154)
[doc] Make subprocess.wait documentation more precise (GH-98700)

[doc] Make subprocess.wait doc more precise

An active loop is only used when the `timeout` parameter is used on
POSIX.

When no timeout is used, the code calls `os.waitpid` internally (which puts
the process on a sleep status). On Windows, the internal Windows API
call accepts a timeout parameter, so that is delegated to the OS.
(cherry picked from commit 81ab0e8a4a)

Co-authored-by: Luis Pedro Coelho <luis@luispedro.org>
2023-12-13 12:01:36 -08:00
Miss Islington (bot)
9b3447ca3c
[3.11] gh-101100: Improve docs on exception attributes (GH-113057) (#113062)
gh-101100: Improve docs on exception attributes (GH-113057)

(cherry picked from commit d05a180350)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-13 19:07:19 +00:00
Hugo van Kemenade
51858aa606
[3.11] gh-101100: Fix Sphinx warning in references with asterisks (GH-113029) (#113044) 2023-12-13 11:02:20 +02:00
Serhiy Storchaka
f78f6b6e89
[3.11] gh-112999: Replace the outdated "deprecated" directives with "versionchanged" (GH-113000) (GH-113020)
(cherry picked from commit fe9991bb67)
2023-12-12 17:17:35 +00:00
Alex Waygood
f83087ce03
[3.11] gh-101100: Improve documentation on function attributes (#112933) (#113003)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-12 14:19:02 +02:00
Miss Islington (bot)
4cc9e875c2
[3.11] gh-101100: Fix Sphinx warning in library/http.cookies.rst (GH-112908) (#112930)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Fix Sphinx warning in library/http.cookies.rst (GH-112908)
2023-12-10 12:59:29 +00:00
Alex Waygood
8c51e4030a
[3.11] gh-101100: Fix Sphinx nitpicks in library/tempfile.rst (#112886) (#112913)
(cherry-picked from commit 54410e6bd9)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-09 22:56:01 +00:00
Miss Islington (bot)
c95aa4e310
[3.11] gh-101100: Improve documentation of TracebackType attributes (GH-112884) (#112912)
gh-101100: Improve documentation of `TracebackType` attributes (GH-112884)
(cherry picked from commit 96f64a2b1b)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-09 22:50:01 +00:00
Alex Waygood
23234e9223
[3.11] gh-101100: Fix Sphinx nits in library/contextlib.rst (#112870) (#112874)
(cherry-picked from commit e4c0876033)
2023-12-08 14:03:15 +00:00
Miss Islington (bot)
161cfd0dda
[3.11] gh-101100: Improve documentation for attributes on instance methods (GH-112832) (#112873)
gh-101100: Improve documentation for attributes on instance methods (GH-112832)
(cherry picked from commit ed21d0c1f4)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-08 13:25:05 +00:00
Miss Islington (bot)
5a11bcbf71
[3.11] gh-101100: Fix Sphinx nitpicks in library/shelve.rst (GH-112836) (#112869)
gh-101100: Fix Sphinx nitpicks in `library/shelve.rst` (GH-112836)
(cherry picked from commit 3cdcc2edf8)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-08 12:38:40 +00:00
Alex Waygood
5fa2d24002
[3.11] gh-101100: Improve documentation of code object attributes (#112781) (#112817)
(cherry-picked from commit e9707d3c3d)
2023-12-06 22:23:20 +00:00
Alex Waygood
1e719d374c
[3.11] gh-101100: Fix Sphinx nitpicks in library/reprlib.rst (#112811) (#112815)
(cherry-picked from commit 3870d19d15)
2023-12-06 22:04:33 +00:00
Miss Islington (bot)
02d09510d2
[3.11] gh-101100: Fix most Sphinx nitpicks in the glossary and stdtypes.rst (GH-112757) (#112790)
gh-101100: Fix most Sphinx nitpicks in the glossary and `stdtypes.rst` (GH-112757)
(cherry picked from commit e3f670e137)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-06 08:50:49 +00:00
Alex Waygood
c26d6c1aba
[3.11] gh-101100: Properly document frame object attributes (#112735) (#112775)
* [3.11] gh-101100: Properly document frame object attributes (#112735)

(cherry-picked from commit d109f637c0)
2023-12-05 20:23:25 +00:00
Miss Islington (bot)
80c314c9ce
[3.11] gh-101100: Fix many easily solvable Sphinx nitpicks in the datamodel docs (GH-112737) (#112749)
gh-101100: Fix many easily solvable Sphinx nitpicks in the datamodel docs (GH-112737)
(cherry picked from commit 2f20cafdbf)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-05 10:06:30 +00:00
Miss Islington (bot)
798d43722b
[3.11] gh-101100: Fix Sphinx nitpicks in library/abc.rst (GH-112703) (#112704)
gh-101100: Fix Sphinx nitpicks in `library/abc.rst` (GH-112703)
(cherry picked from commit 9560e0d6d7)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-04 12:48:58 +00:00
Miss Islington (bot)
28afd8ddad
[3.11] gh-101100: Fix sphinx warnings in Doc/library/__future__.rst (GH-109814) (#112701)
gh-101100: Fix sphinx warnings in `Doc/library/__future__.rst` (GH-109814)
(cherry picked from commit f2eaa92b0c)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-12-04 11:54:39 +00:00
Miss Islington (bot)
f60087836e
[3.11] gh-101100: Fix Sphinx nitpicks in library/functions.rst (GH-112669) (#112698)
gh-101100: Fix Sphinx nitpicks in `library/functions.rst` (GH-112669)
(cherry picked from commit cda737924f)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-04 11:11:24 +00:00
Miss Islington (bot)
73411ea95e
[3.11] gh-101100: Fix Sphinx warning in library/gettext.rst (GH-112668) (#112673)
gh-101100: Fix Sphinx warning in `library/gettext.rst` (GH-112668)
(cherry picked from commit 489aeac3a2)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-03 20:30:31 +00:00
Miss Islington (bot)
05ea7e5d4d
[3.11] gh-101100: Fix most Sphinx nitpicks in inspect.rst (GH-112662) (#112667)
gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662)
(cherry picked from commit 45650d1c47)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-03 17:39:10 +00:00
Alex Waygood
999ff4f94a
[3.11] Run more inspect.rst code snippets in CI (#112654) (#112656)
(cherry-picked from commit 4ed46d2244)
2023-12-03 12:01:33 +00:00
Miss Islington (bot)
6ab6c8579c
[3.11] [3.12] gh-112316: improve docs for inspect.signature and inspect.Signature (GH-112631) (GH-112649) (#112652)
[3.12] gh-112316: improve docs for `inspect.signature` and `inspect.Signature` (GH-112631) (GH-112649)

(cherry-picked from commit fc9e24b01f)
(cherry picked from commit 6221482f0c)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-03 11:35:21 +00:00
Alex Waygood
8d8efe7e71
[3.11] gh-112316: Improve docs of inspect.signature and Signature.from_callable (#112317) (#112630)
(cherry-picked from commit a74daba7ca)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-12-02 22:50:16 +00:00
Miss Islington (bot)
0a0cf45f1b
[3.11] gh-110930: Correct book title by Alan D. Moore (GH-112490) (#112524)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-11-29 15:56:20 +00:00
Miss Islington (bot)
b85070ceaf
[3.11] Docs: fix markup for importlib.machinery.NamespaceLoader (GH-112479) (#112482)
Docs: fix markup for `importlib.machinery.NamespaceLoader` (GH-112479)
(cherry picked from commit 2e632fa07d)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-11-28 00:21:18 +00:00
Gregory P. Smith
03b522d3ef
[3.11] Backport PR #112477: correct socket AF_PACKET docs (#112478)
Backport PR #112477: correct socket AF_PACKET docs

Network byte order is not involved in the `int` on the Python side.
That happens under the hood.

Correctly use the term addresses instead of packets.
2023-11-27 23:54:21 +00:00
Miss Islington (bot)
c3e5d0d936
[3.11] gh-68166: Tkinter: Add tests and examples for element_create() (GH-111453) (GH-111858)
* Remove mention of "vsapi" element type from the documentation.
* Add tests for element_create() and other ttk.Style methods.
* Add examples for element_create() in the documentation.

(cherry picked from commit 005d1e8fc8)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-11-27 20:14:30 +00:00
Miss Islington (bot)
62e430af9e
[3.11] GH-101100: Fix reference warnings for `socket` methods (GH-110114) (#112456)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-11-27 17:03:45 +02:00
Miss Islington (bot)
faa1ef4893
[3.11] Docs: fix typo in doc for sqlite3.Cursor.execute (GH-112442) (#112445)
Docs: fix typo in doc for sqlite3.Cursor.execute (GH-112442)
(cherry picked from commit fb79e1ed4a)

Co-authored-by: Tom Levy <tomlevy93@gmail.com>
2023-11-27 09:34:35 +00:00