Commit graph

26718 commits

Author SHA1 Message Date
Miss Islington (bot)
d7d3690af7
[3.11] gh-108731: Add description of __slots__ to MemberDescriptorType docs (GH-108745) (GH-114537)
(cherry picked from commit 6888cccac0)

Co-authored-by: plokmijnuhby <39633434+plokmijnuhby@users.noreply.github.com>
2024-01-24 20:05:12 +00:00
Miss Islington (bot)
94c5567e91
[3.11] Docs: mark up the FTP_TLS() docs with param list (GH-114510) (#114533)
Also turn sentence about prot_p() into a note.

(cherry picked from commit 6fadd68da5)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-24 17:28:55 +01:00
Hugo van Kemenade
aa17d917e1
[3.11] gh-101100: Fix sphinx warnings in concurrent.futures.rst (GH-114521) (#114526)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-01-24 13:46:13 +00:00
Miss Islington (bot)
208db89fe6
[3.11] gh-101100: Fix sphinx warnings in asyncio-task.rst (GH-114469) (#114518)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-01-24 00:32:00 -07:00
Miss Islington (bot)
018b637a52
[3.11] Fix a typo in the contextlib documentation (GH-114507) (#114515) 2024-01-24 04:22:38 +00:00
Miss Islington (bot)
e85f4c6fa9
[3.11] Docs: use placeholders in dbm flag param docs (GH-114482) (#114498)
Also correct the default flag param for dbm.dumb.open();
it's 'c', not 'r'.
(cherry picked from commit 8c265408c5)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-23 21:05:39 +01:00
Miss Islington (bot)
8790e5799a
[3.11] Docs: mark up FTP.connect() and FTP.login() with param lists (GH-114395) (#114486)
Use rst substitutions to reduce raw text duplication.

(cherry picked from commit 01105c7c4f)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-23 14:03:51 +00:00
Miss Islington (bot)
ec71690fcc
[3.11] Docs: mark up FTP.retrbinary and FTP.storbinary with param lists (GH-114399) (#114484)
(cherry picked from commit 5277d4c7db)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2024-01-23 14:00:35 +00:00
Miss Islington (bot)
b62db465e5
[3.11] gh-101100: Fix sphinx warnings in Doc/library/locale.rst (GH-114425) (#114478)
gh-101100: Fix sphinx warnings in `Doc/library/locale.rst` (GH-114425)

* gh-101100: Fix sphinx warnings in `Doc/library/locale.rst`

* Remove `/` from signatures
(cherry picked from commit 7d21cae964)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-01-23 13:24:51 +02:00
Erlend E. Aasland
eb94a0426f
[3.11] Docs: align usage of versionadded/versionchanged with recommended practice (#114409) (#114473)
(cherry picked from commit 1d7bddd961)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2024-01-23 10:39:25 +01:00
Miss Islington (bot)
1f04ac8e27
[3.11] GH-105900: Fix pathlib.Path.symlink_to(target_is_directory=...) docs (GH-114035) (#114465)
Clarify that *target_is_directory* only matters if the target doesn't
exist.
(cherry picked from commit b822b85ac1)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
2024-01-23 05:37:32 +00:00
Miss Islington (bot)
9d2ad6f24a
[3.11] GH-82695: Clarify pathlib.Path.mkdir() documentation (GH-114032) (#114463)
Remove a double negative in the documentation of `mkdir()`'s *exist_ok*
parameter.

(cherry picked from commit 32c227470a)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-01-23 02:37:55 +00:00
Barney Gale
20f3669ac2
[3.11] GH-99334: Explain that PurePath.is_relative_to() is purely lexical. (GH-114031) (#114461)
(cherry picked from commit 3a61d24062)
2024-01-23 01:16:21 +00:00
Miss Islington (bot)
dcda3aaa6a
[3.11] gh-66944: Note that the contextlib.closing example is for illustrative purposes (GH-112198) (#114459) 2024-01-23 01:07:14 +00:00
Miss Islington (bot)
350b4c7c0c
[3.11] gh-101100: Fix Sphinx warnings in reference/expressions.rst (GH-114194) (#114437)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-22 18:50:28 +02:00
Serhiy Storchaka
459726f6cd
[3.11] gh-114115: Update documentation of array.array (GH-114117) (GH-114418)
(cherry picked from commit 650f9e4c94)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-22 09:37:09 +00:00
Erlend E. Aasland
9f164ab70b
[3.11] Docs: align sqlite3 docs with versionadded/versionchanged recommendations (#114400) (#114403)
(cherry picked from commit 336030161a)

When a parameter is added to a function or method, use the 'versionchanged'
directive, not 'versionadded'.
2024-01-21 20:07:46 +00:00
Miss Islington (bot)
a4587c1846
[3.11] Docs: link to sys.stdout in ftplib docs (GH-114396) (#114398)
(cherry picked from commit de17cf444a)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-21 17:47:48 +00:00
Miss Islington (bot)
d2cfb5b258
[3.11] gh-114384: Align sys.set_asyncgen_hooks signature in docs to reflect implementation (GH-114385) (#114387)
(cherry picked from commit 38768e4cdd)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-01-21 13:03:53 +00:00
Miss Islington (bot)
d2551cfc6b
[3.11] Docs: mark up FTP() constructor with param list (GH-114359) (#114383)
(cherry picked from commit 96c15b1c8d)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-21 11:33:37 +00:00
Miss Islington (bot)
bd8bd4f404
[3.11] Docs: mark up the FTP debug levels as a list (GH-114360) (#114376)
(cherry picked from commit fbc28748ea)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-21 11:26:55 +01:00
Miss Islington (bot)
274b93a584
[3.11] gh-101100: Fix sphinx warnings in Doc/c-api/memory.rst (GH-114373) (#114378)
gh-101100: Fix sphinx warnings in `Doc/c-api/memory.rst` (GH-114373)
(cherry picked from commit 47133d8d86)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-01-21 09:40:43 +00:00
Miss Islington (bot)
3681effafb
[3.11] Fix the confusing "User-defined methods" reference in the datamodel (GH-114276) (#114366) 2024-01-21 03:52:30 +00:00
Erlend E. Aasland
4913dc2090
[3.11] Docs: structure the ftplib reference (#114317) (#114351)
(cherry picked from commit b1ad5a5d44)

Introduce the following headings and subheadings:

- Reference
  * FTP objects
  * FTP_TLS objects
  * Module variables
2024-01-20 19:37:04 +00:00
Adam Turner
8e17470710
[3.11] GH-99380: Update to Sphinx 7 (GH-99381) (#114342)
(cherry picked from commit e6495159f6)
2024-01-20 11:31:06 +00:00
Miss Islington (bot)
685d88d8ad
[3.11] gh-114332: Fix the flags reference for `re.compile()` (GH-114334) (#114340)
gh-114332: Fix the flags reference for ``re.compile()`` (GH-114334)

The GH-93000 change set inadvertently caused a sentence in re.compile()
documentation to refer to details that no longer followed. Correct this
with a link to the Flags sub-subsection.

(cherry picked from commit 567a85e9c1)

Co-authored-by: David H. Gutteridge <dhgutteridge@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-01-20 11:23:23 +00:00
Miss Islington (bot)
2e6a3a6378
[3.11] Retain shorter tables of contents for Sphinx 5.2.3+ (GH-114318) (#114338) 2024-01-20 10:33:19 +00:00
Nikita Sobolev
a4ad7a0ac5
[3.11] gh-108303: Move all doctest related files and tests to Lib/test/test_doctest/ (GH-112109) (#114313)
gh-108303: Move all doctest related files and tests to `Lib/test/test_doctest/` (GH-112109)
2024-01-19 16:12:48 +01:00
Miss Islington (bot)
ac4c6efc70
[3.11] gh-112092: clarify unstable ABI recompilation requirements (GH-112093) (#114261)
gh-112092: clarify unstable ABI recompilation requirements (GH-112093)

Use different versions in the examples for when extensions do and do not need to be recompiled to make the examples easier to understand.
(cherry picked from commit 68a7b78cd5)

Co-authored-by: DerSchinken <53398996+DerSchinken@users.noreply.github.com>
2024-01-18 21:28:34 +01:00
Miss Islington (bot)
9887b0c396
[3.11] gh-114231: Fix indentation in enum.rst (GH-114232) (#114235)
Co-authored-by: Miyashita Yosuke <44266492+miyashiiii@users.noreply.github.com>
2024-01-18 09:29:44 +00:00
Miss Islington (bot)
4ec2e2eeee
[3.11] gh-114211: Update EmailMessage doc about ordered keys (GH-114224) (#114226)
Ordered keys are no longer unlike 'real dict's.
(cherry picked from commit 8cda72037b)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-01-17 21:56:03 -05:00
Miss Islington (bot)
5dcb15da88
[3.11] Fix typo in tkinter.ttk.rst (GH-106157) (GH-114201)
(cherry picked from commit 7573c44c32)

Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
2024-01-17 21:24:10 +02:00
Miss Islington (bot)
654c70a655
[3.11] gh-114070: fix token reference warnings in expressions.rst (GH-114169) (#114193)
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-01-17 18:53:08 +02:00
Miss Islington (bot)
bda62c0b22
[3.11] gh-102468: Document PyCFunction_New* and PyCMethod_New (GH-112557) (GH-114120)
gh-102468: Document `PyCFunction_New*` and `PyCMethod_New` (GH-112557)
(cherry picked from commit a482bc67ee)

Co-authored-by: AN Long <aisk@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2024-01-17 10:21:16 +01:00
Miss Islington (bot)
8cb1b797fb
[3.11] gh-72284: Revise lists in IDLE doc (GH-114174) (#114176)
Tkinter is a fact, not necessarily a feature.

Reorganize editor key bindings in a logical order
and remove those that do not work, at least on Windows.

Improve shell bindings list.
(cherry picked from commit 4a32275389)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-01-17 03:35:35 -05:00
Miss Islington (bot)
644b4a1e87
[3.11] gh-112043: Align concurrent.futures.Executor.map docs with implementation (GH-114153) (#114165)
The first parameter is named 'fn', not 'func'.
(cherry picked from commit 8d26db45df)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-17 01:38:06 +00:00
Miss Islington (bot)
b21dd36495
[3.11] gh-88531 Fix dataclass __post_init__/__init__ interplay documentation (gh-107404) (#114163)
* Simplify __post_init__ example usage. It applies to all base classes, not just dataclasses.
(cherry picked from commit 05008c27b7)

Co-authored-by: Steffen Zeile <48187781+Kaniee@users.noreply.github.com>
2024-01-17 01:33:09 +00:00
Miss Islington (bot)
9351b5ddf1
[3.11] gh-94220: Align fnmatch docs with the implementation and amend markup (GH-114152) (#114156)
- Align the argument spec for fnmatch functions with the actual
  implementation.
- Update Sphinx markup to recent recommandations.
- Add link to 'iterable' glossary entry.

(cherry picked from commit 6e84f3b56f)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-01-16 23:42:57 +01:00
Erlend E. Aasland
2122e1ee83
[3.11] Docs: Improve multiprocessing.SharedMemory reference (#114093) (#114138)
(cherry picked from b1db6278cf)

Align the multiprocessing shared memory docs with Diatáxis's
recommendations for references.

- use a parameter list for the SharedMemory.__init__() argument spec
- use the imperative mode
- use versionadded, not versionchanged, for added parameters
- reflow touched lines according to SemBr
2024-01-16 17:18:34 +00:00
Miss Islington (bot)
d42e54e9d6
[3.11] gh-114069: Revise Tutorial Methods paragraph (GH-114127) (#114132)
gh-114069: Revise Tutorial Methods paragraph (GH-114127)

Remove excess words in the first and third sentences.
(cherry picked from commit 31a2543c80)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-01-16 16:43:23 +00:00
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
Alois Klink
0d12a64eaf
[3.11] gh-95649: Document that asyncio contains uvloop code (GH-107536) (#114045)
Some of the asyncio SSL changes in GH-31275 [1] were taken from
v0.16.0 of the uvloop project [2]. In order to comply with the MIT
license, we need to just need to document the copyright information.

[1]: https://github.com/python/cpython/pull/31275
[2]: https://github.com/MagicStack/uvloop/tree/v0.16.0

(cherry picked from commit dce30c9cbc)
2024-01-14 02:14:51 +00:00
Miss Islington (bot)
25af45d9a4
[3.11] gh-114021: Pin various sphinxcontrib extensions to older versions (GH-114022) (#114029)
[3.12] gh-114021: Pin various sphinxcontrib extensions to older versions (GH-114022)
(cherry picked from commit 94b1d1fa38)

Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
2024-01-13 17:44:58 +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)
cd8fd2292e
[3.11] datamodel: Fix a typo in `object.__init_subclass__` (GH-111599) (#114005)
datamodel: Fix a typo in ``object.__init_subclass__`` (GH-111599)
(cherry picked from commit a47353d587)

Co-authored-by: InSync <122007197+InSyncWithFoo@users.noreply.github.com>
2024-01-12 23:06:14 +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)
e276743682
[3.11] Tutorial: Clarify 'nonzero exit status' in the appendix (GH-112039) (#114000)
Tutorial: Clarify 'nonzero exit status' in the appendix (GH-112039)
(cherry picked from commit 32f3684b8f)

Co-authored-by: Andrew Zipperer <47086307+zipperer@users.noreply.github.com>
2024-01-12 22:48:32 +00:00