Commit graph

12726 commits

Author SHA1 Message Date
Miss Islington (bot)
84223a0e0a
[3.12] gh-101100: Fix sphinx warnings in library/email.mime.rst (GH-114635) (GH-114640)
(cherry picked from commit 6a8944acb6)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-01-27 08:53:34 +00:00
Miss Islington (bot)
bf35ac1d4c
[3.12] Docs: rework the dbm.dumb introduction (GH-114550) (#114620)
(cherry picked from commit 6c2b419fb9)

- consistently use correct parameter markup
- consistently use submodule name as database name
- improve accuracy of the dbm.dumb.open() spec
- remove dumbdbm class refs and replace them with generic "database object"
- use parameter list for dbm.dumb.open()
(cherry picked from commit 6c2b419fb9)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-26 18:19:20 +00:00
Miss Islington (bot)
61f8f58f81
[3.12] Docs: mark up dbm.open() with param list (GH-114601) (#114604)
Also consolidate following paragraphs regarding database objects.

(cherry picked from commit 0bd8297a22)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-26 15:18:10 +00:00
Erlend E. Aasland
9726cabfb6
[3.12] Docs: reword dbm.ndbm introduction (#114549) (#114599)
(cherry picked from commit 4cf068ed08)

- add abbreviation directives for NDBM and GDBM
- consistently spell NDBM as NDBM
- silence broken ndbm class refs
- improve accuracy of dbm.ndbm.open() spec
- use replacement text for NDBM/GDBM file format incompatibility note
2024-01-26 13:56:39 +01:00
Miss Islington (bot)
4545845d7a
[3.12] Docs: fix versionchanged directives for dbm.open() and dbm.whichdb() (GH-114594) (#114595)
(cherry picked from commit 8710faeac2)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-26 12:42:31 +00:00
Miss Islington (bot)
3604117242
[3.12] Docs: rework dbm introduction (GH-114551) (#114590)
- add refs to other parts of the docs (dict, bytes, etc.)
- clarify whichdb() return value by using list markup
- silence refs to example or generic submodule methods (keys, get, etc.)

(cherry picked from commit 65cf5dce11)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-26 10:23:55 +00:00
Erlend E. Aasland
f416af903f
[3.12] Docs: reword dbm.gnu introduction (#114548) (#114588)
(cherry picked from commit 06c5de36f2)

Also...
- consistently spell GDBM as GDBM
- silence gdbm class refs
- improve accuracy of dbm.gdbm.open() spec
2024-01-26 10:13:35 +00:00
Miss Islington (bot)
e122081432
[3.12] gh-108731: Add description of __slots__ to MemberDescriptorType docs (GH-108745) (GH-114536)
(cherry picked from commit 6888cccac0)

Co-authored-by: plokmijnuhby <39633434+plokmijnuhby@users.noreply.github.com>
2024-01-24 20:05:24 +00:00
Miss Islington (bot)
66b7ae6f35
[3.12] Docs: mark up the FTP_TLS() docs with param list (GH-114510) (#114532)
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:34 +01:00
Miss Islington (bot)
26f8a30de6
[3.12] gh-104360: remove reference to removed module-level wrap_socket (GH-104361) (GH-114528)
* remove reference to removed module-level wrap_socket
* drive by typo fix
(cherry picked from commit 127a497852)

Co-authored-by: Thomas Grainger <tagrain@gmail.com>
2024-01-24 14:31:34 +00:00
Hugo van Kemenade
085e5d765a
[3.12] gh-101100: Fix sphinx warnings in concurrent.futures.rst (GH-114521) (#114525)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-01-24 13:44:22 +00:00
Hugo van Kemenade
0c42897f8d
[3.12] gh-101100: Fix sphinx warnings in asyncio-task.rst (GH-114469) (#114519)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-01-24 00:40:22 -07:00
Miss Islington (bot)
2692f5b6d2
[3.12] Fix a typo in the contextlib documentation (GH-114507) (#114514) 2024-01-24 04:22:37 +00:00
Miss Islington (bot)
a73a6a3c69
[3.12] Docs: use placeholders in dbm flag param docs (GH-114482) (#114497)
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:21 +01:00
Miss Islington (bot)
d492b19856
[3.12] Docs: mark up FTP.connect() and FTP.login() with param lists (GH-114395) (#114485)
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:04:01 +00:00
Miss Islington (bot)
e18ceb7564
[3.12] Docs: mark up FTP.retrbinary and FTP.storbinary with param lists (GH-114399) (#114483)
(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:27 +00:00
Miss Islington (bot)
1b9abe4acc
[3.12] gh-101100: Fix sphinx warnings in Doc/library/locale.rst (GH-114425) (#114477)
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:23:31 +02:00
Erlend E. Aasland
3efcf6673e
[3.12] Docs: align usage of versionadded/versionchanged with recommended practice (#114409) (#114472)
(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:57 +01:00
Miss Islington (bot)
ccd8d77112
[3.12] GH-105900: Fix pathlib.Path.symlink_to(target_is_directory=...) docs (GH-114035) (#114464)
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:36:16 +00:00
Miss Islington (bot)
9c2db5725e
[3.12] GH-82695: Clarify pathlib.Path.mkdir() documentation (GH-114032) (#114462)
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:35 +00:00
Miss Islington (bot)
a199ab3f33
[3.12] GH-99334: Explain that PurePath.is_relative_to() is purely lexical. (GH-114031) (#114460)
(cherry picked from commit 3a61d24062)
2024-01-23 01:12:59 +00:00
Miss Islington (bot)
536b66f8fa
[3.12] gh-66944: Note that the contextlib.closing example is for illustrative purposes (GH-112198) (#114458) 2024-01-23 01:07:34 +00:00
Miss Islington (bot)
d705582f73
[3.12] Docs: Fix typo in code snippet (GH-114421) (GH-114434)
(cherry picked from commit 6d30cbee01)

Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
2024-01-22 16:03:22 +00:00
Serhiy Storchaka
7da1750225
[3.12] gh-114115: Update documentation of array.array (GH-114117) (GH-114417)
(cherry picked from commit 650f9e4c94)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-22 09:37:16 +00:00
Miss Islington (bot)
33c1907de2
[3.12] gh-114328: tty cbreak mode should not alter ICRNL (GH-114335) (#114410)
The terminal CR -> NL mapping setting should be inherited in cbreak mode as OSes do not specify altering it as part of their stty cbreak mode definition.
(cherry picked from commit fd49e22670)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2024-01-21 23:41:03 +00:00
Erlend E. Aasland
5183a5dee5
[3.12] Docs: align sqlite3 docs with versionadded/versionchanged recommendations (#114400) (#114402)
(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:04:01 +00:00
Miss Islington (bot)
1138fb545f
[3.12] Docs: link to sys.stdout in ftplib docs (GH-114396) (#114397)
(cherry picked from commit de17cf444a)

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

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-01-21 13:22:57 +00:00
Miss Islington (bot)
24fa45b59f
[3.12] Docs: mark up FTP() constructor with param list (GH-114359) (#114382)
(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:23 +00:00
Miss Islington (bot)
5dc4857661
[3.12] Docs: mark up the FTP debug levels as a list (GH-114360) (#114375)
(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:34 +01:00
Miss Islington (bot)
48bff74590
[3.12] Docs: Add missing line continuation to FTP_TLS class docs (GH-114352) (#114353)
Docs: Add missing line continuation to FTP_TLS class docs (GH-114352)

Regression introduced by b1ad5a5d4.
(cherry picked from commit 8f4f773647)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-20 21:21:00 +01:00
Miss Islington (bot)
a4eb0720f1
[3.12] Docs: structure the ftplib reference (GH-114317) (#114347)
Docs: structure the ftplib reference (GH-114317)

Introduce the following headings and subheadings:

- Reference
  * FTP objects
  * FTP_TLS objects
  * Module variables
(cherry picked from commit b1ad5a5d44)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-20 19:16:53 +00:00
Miss Islington (bot)
7a56df1266
[3.12] gh-114332: Fix the flags reference for `re.compile()` (GH-114334) (#114339)
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:37 +00:00
Miss Islington (bot)
a76d0104d7
[3.12] gh-108303: Move all doctest related files and tests to Lib/test/test_doctest/ (GH-112109) (#114254)
gh-108303: Move all doctest related files and tests to `Lib/test/test_doctest/` (GH-112109)
(cherry picked from commit 9c93350f58)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Brett Cannon <brett@python.org>
2024-01-18 16:25:04 +00:00
Miss Islington (bot)
55b73a5c78
[3.12] gh-114231: Fix indentation in enum.rst (GH-114232) (#114234)
Co-authored-by: Miyashita Yosuke <44266492+miyashiiii@users.noreply.github.com>
2024-01-18 09:29:34 +00:00
Miss Islington (bot)
87198f6c23
[3.12] gh-114211: Update EmailMessage doc about ordered keys (GH-114224) (#114225)
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:55:40 -05:00
Miss Islington (bot)
01344cfe9e
[3.12] Fix typo in tkinter.ttk.rst (GH-106157) (GH-114200)
(cherry picked from commit 7573c44c32)

Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
2024-01-17 21:23:50 +02:00
Miss Islington (bot)
5af161ffe6
[3.12] gh-72284: Revise lists in IDLE doc (GH-114174) (#114175)
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:19 -05:00
Miss Islington (bot)
5b08b24f89
[3.12] gh-112043: Align concurrent.futures.Executor.map docs with implementation (GH-114153) (#114164)
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:37:30 +00:00
Miss Islington (bot)
12c6424205
[3.12] gh-88531 Fix dataclass __post_init__/__init__ interplay documentation (gh-107404) (#114162)
* 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:02 +00:00
Miss Islington (bot)
50bb9c69e1
[3.12] gh-94220: Align fnmatch docs with the implementation and amend markup (GH-114152) (#114155)
- 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:29 +01:00
Barney Gale
0ee681a665
[3.12] GH-78988: Document pathlib.Path.glob() exception propagation. (GH-114036) (#114154)
We propagate the `OSError` from the `is_dir()` call on the top-level
directory, and suppress all others.

(cherry picked from commit 7092b3f131)
2024-01-16 22:39:09 +00:00
Erlend E. Aasland
91739149f0
[3.12] Docs: Improve multiprocessing.SharedMemory reference (#114093) (#114137)
(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:17:29 +00:00
Erlend E. Aasland
4888db15fe
[3.12] Docs: Align multiprocessing.shared_memory docs with Sphinx recommendations (#114103) (#114112)
(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 12:56:07 +00:00
Raymond Hettinger
2b025793e1
[3.12] Update KDE recipe to match the standard use of the h parameter (gh-113958) (#114098) 2024-01-15 22:46:01 -06:00
Miss Islington (bot)
f6315edca1
[3.12] gh-114070: correct the specification of `digit` in the float() docs (GH-114080) (#114094)
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:25:51 +00:00
Hugo van Kemenade
cc11c76da7
[3.12] gh-101100: Fix Sphinx warnings in howto/urllib2.rst and library/http.client.rst (GH-114060) (#114063)
(cherry picked from commit c2808431b3)
2024-01-14 21:14:08 +00:00
Miss Islington (bot)
1ea6658342
[3.12] gh-89159: Document missing TarInfo members (GH-91564) (#114006)
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:08 +00:00
Miss Islington (bot)
b9e15bef82
[3.12] Link to the glossary for "magic methods" in `MagicMock` (GH-111292) (#114002)
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:00:50 +00:00
Miss Islington (bot)
d50d074cd9
[3.12] Improve kde graph with better caption and number formatting (gh-113967) (gh-113968) 2024-01-11 18:49:10 -06:00