Commit graph

12373 commits

Author SHA1 Message Date
Erlend E. Aasland
e5ae15f0fe
[3.11] Docs: Align multiprocessing.shared_memory docs with Sphinx recommendations (#114103) (#114114)
(cherry picked from commit af85274086)

- add :class: and :mod: markups where needed
- fix incorrect escaping of a star in ShareableList arg spec
- mark up parameters with stars: *val*
- mark up list of built-in types using list markup
- remove unneeded parentheses from :meth: markups
2024-01-16 13:08:01 +00:00
Barney Gale
f5cbed1114
[3.11] GH-101130: Document multiple arguments for PurePath.[is_]relative_to() (#114034)
3.11-only change as this is already covered in the 3.12+ deprecation
warning.
2024-01-16 01:37:55 +00:00
Miss Islington (bot)
76433f8c45
[3.11] gh-114070: correct the specification of `digit` in the float() docs (GH-114080) (#114095)
gh-114070: correct the specification of ``digit`` in the float() docs (GH-114080)
(cherry picked from commit 4f24b92aa0)

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-01-15 22:26:40 +00:00
Hugo van Kemenade
3a181a10b1
[3.11] gh-101100: Fix Sphinx warnings in howto/urllib2.rst and library/http.client.rst (GH-114060) (#114064)
(cherry picked from commit c2808431b3)
2024-01-14 21:14:11 +00:00
Miss Islington (bot)
d7a544ad3b
[3.11] gh-89159: Document missing TarInfo members (GH-91564) (#114007)
gh-89159: Document missing TarInfo members (GH-91564)
(cherry picked from commit 3aa4b839e4)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2024-01-12 23:26:03 +00:00
Miss Islington (bot)
2d184b26df
[3.11] Link to the glossary for "magic methods" in `MagicMock` (GH-111292) (#114003)
Link to the glossary for "magic methods" in ``MagicMock`` (GH-111292)

The MagicMock documentation mentions magic methods several times without
actually pointing to the term in the glossary. This can be helpful for
people to fully understand what those magic methods are.
(cherry picked from commit e97da8677f)

Co-authored-by: Pierre Equoy <pierre.equoy@canonical.com>
2024-01-12 23:01:09 +00:00
Miss Islington (bot)
535b1dedb3
[3.11] GH-107678: Improve Unicode handling clarity in `library/re.rst` (GH-107679) (#113966)
GH-107678: Improve Unicode handling clarity in ``library/re.rst`` (GH-107679)
(cherry picked from commit c9b8a22f34)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-01-12 00:02:35 +00:00
Adam Turner
71288ed8b0
[3.11] GH-92584: Move installation schemes overview to sysconfig docs (GH-108018) (#110214)
* 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)
2024-01-11 23:48:10 +00:00
Steve Dower
186c021688
gh-81489: Use Unicode APIs for mmap tagname on Windows (GH-14133)
Co-authored-by: Zackery Spytz <zspytz@gmail.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-11 23:04:36 +00:00
Serhiy Storchaka
c92a473a71
[3.11] gh-113664: Improve style of Big O notation (GH-113695) (GH-113910)
Use cursive to make it looking like mathematic formulas.
(cherry picked from commit a8629816c6)
2024-01-10 13:13:27 +00:00
Miss Islington (bot)
3958c7d712
[3.11] Docs: Link tokens in the format string grammars (GH-108184) (#113840)
Docs: Link tokens in the format string grammars (GH-108184)
(cherry picked from commit f3d5d4aa8f)

Co-authored-by: William Andrea <william.j.andrea@gmail.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-01-09 02:53:59 +00:00
Miss Islington (bot)
6aa86bdcb2
[3.11] gh-113360: Fix the documentation of module's attribute __test__ (GH-113393) (GH-113761)
It can only be a dict since Python 2.4.
(cherry picked from commit d99d871225)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-01-05 22:29:14 +00:00
Miss Islington (bot)
9dd73ccbb0
[3.11] gh-101100: Fix Sphinx warnings in library/pyclbr.rst (GH-113739) (#113749)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-01-05 21:36:58 +02:00
Miss Islington (bot)
2a4a724cdf
[3.11] gh-101100: Fix Sphinx warnings for 2.6 deprecations and removals (GH-113725) (#113735)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2024-01-05 16:02:07 +02:00
Alex Waygood
c828dbc196
[3.11] Document the co_lines method on code objects (#113682) (#113687)
(cherry-picked from commit f1f8392432)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2024-01-03 19:59:10 +00:00
Miss Islington (bot)
3a9bf03ac9
[3.11] functools.partial docs: Use the more common spelling for "referenceable" (GH-113675) (#113678)
`functools.partial` docs: Use the more common spelling for "referenceable" (GH-113675)
(cherry picked from commit 4de468cce1)

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2024-01-03 13:19:49 +00:00
Hugo van Kemenade
5169113379
[3.11] gh-101100: Fix Sphinx warnings in library/configparser.rst (GH-113598) (#113600)
(cherry picked from commit 30a6d79fb8)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-31 18:18:49 +00:00
Miss Islington (bot)
02912125b4
[3.11] Update ConfigParser docs defining valid section name (GH-110506) (#113590)
Co-authored-by: Delgan <4193924+Delgan@users.noreply.github.com>
2023-12-30 23:24:39 +00:00
Miss Islington (bot)
206dc9a82e
[3.11] gh-89414: Document that SIGCLD is not available on macOS (GH-113580) (#113586)
gh-89414: Document that SIGCLD is not available on macOS (GH-113580)

Document that SIGCLD is not available on macOS
(cherry picked from commit f48a1bcb29)

Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
2023-12-30 18:10:11 +01:00
Miss Islington (bot)
2025d9fba2
[3.11] Doc/library/os.rst: os.waitid absent on MacOS (GH-104558) (#113554)
Doc/library/os.rst: `os.waitid` absent on MacOS (GH-104558)

* Doc/library/os.rst: `os.waitid` absent on MacOS

(cherry picked from commit db1c882239)

Co-authored-by: John Hawkinson <jhawk@alum.mit.edu>
Co-authored-by: AN Long <aisk@users.noreply.github.com>
2023-12-29 09:27:19 +01:00
Miss Islington (bot)
4d0b50ac9a
[3.11] gh-101100: Fix Sphinx warnings in library/random.rst (GH-112981) (#113552)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-28 12:40:46 -07:00
Miss Islington (bot)
f9d25b56e1
[3.11] gh-67641: Clarify documentation on bytes vs text with non-seeking tarfile stream (GH-31610) (GH-113520)
(cherry picked from commit 0651936ae2)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2023-12-27 17:33:00 +00:00
Miss Islington (bot)
050d50a28d
[3.11] gh-101100: Fix Sphinx warnings in library/cmd.rst (GH-113502) (#113510)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-27 10:24:18 +00:00
Miss Islington (bot)
e095f374bb
[3.11] gh-101100: Fix Sphinx warnings in library/calendar.rst (GH-113500) (#113508)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-27 09:42:57 +00:00
Hugo van Kemenade
5b5d774679
[3.11] gh-101100: Fix Sphinx warnings in library/bisect.rst (GH-113496) (#113505) 2023-12-26 14:54:07 -07:00
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