Commit graph

27273 commits

Author SHA1 Message Date
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)
69f876a82a
[3.12] gh-101100: Fix sphinx warnings in Doc/c-api/memory.rst (GH-114373) (#114377)
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:41:00 +00:00
Miss Islington (bot)
f7d5d936ab
[3.12] Fix the confusing "User-defined methods" reference in the datamodel (GH-114276) (#114365) 2024-01-21 03:52:04 +00: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
Adam Turner
82ad7857aa
[3.12] GH-99380: Update to Sphinx 7 (GH-99381) (#114341)
(cherry picked from commit e6495159f6)
2024-01-20 11:28:34 +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)
6279b2dc15
[3.12] Retain shorter tables of contents for Sphinx 5.2.3+ (GH-114318) (#114337) 2024-01-20 10:33:15 +00:00
Miss Islington (bot)
f9158d63b1
[3.12] gh-112092: clarify unstable ABI recompilation requirements (GH-112093) (#114260)
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:04 +01: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)
281fef1e4c
[3.12] gh-111301: Advertise importlib methods removal in What's new in Python 3.12 (GH-111630) (GH-114187)
(cherry picked from commit f49752552e)

Co-authored-by: Karolina Surma <33810531+befeleme@users.noreply.github.com>
2024-01-18 14:38:13 +01: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)
74a6b7f639
[3.12] gh-114070: fix token reference warnings in expressions.rst (GH-114169) (#114192)
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-01-17 16:46:02 +00:00
Miss Islington (bot)
27941b14ab
[3.12] gh-102468: Document PyCFunction_New* and PyCMethod_New (GH-112557) (GH-114119)
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:08 +01: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
Miss Islington (bot)
3eeab87feb
[3.12] gh-114069: Revise Tutorial Methods paragraph (GH-114127) (#114131)
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:20 +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
Alois Klink
fa7d8e97c2
[3.12] gh-95649: Document that asyncio contains uvloop code (GH-107536) (#114046)
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:15:06 +00:00
Ronald Oussoren
94b1d1fa38
[3.12] gh-114021: Pin various sphinxcontrib extensions to older versions (#114022) 2024-01-13 17:39:02 +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)
d577225104
[3.12] datamodel: Fix a typo in `object.__init_subclass__` (GH-111599) (#114004)
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:05:48 +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)
68d1e30c94
[3.12] Tutorial: Clarify 'nonzero exit status' in the appendix (GH-112039) (#113999)
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:59 +00:00
Miss Islington (bot)
eb22afb004
[3.12] Docs: Amend codeobject.co_lines docs; end number is exclusive (GH-113970) (#113987)
The end number should be exclusive, not inclusive.
(cherry picked from commit e68806c712)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2024-01-12 15:10:43 +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
Miss Islington (bot)
bd9ea91e5f
[3.12] GH-107678: Improve Unicode handling clarity in `library/re.rst` (GH-107679) (#113965)
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:28 +00:00
Miss Islington (bot)
b902671d36
gh-81489: Use Unicode APIs for mmap tagname on Windows (GH-14133)
(cherry picked from commit b4d4aa9e8d)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-11 23:13:02 +00:00
Miss Islington (bot)
5c238225f6
[3.12] gh-112419: Document removal of sys.meta_path's 'find_module' fallback (GH-112421) (#113934)
(cherry picked from commit ec23e90082)

Co-authored-by: AN Long <aisk@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-11 09:49:21 +00:00
Miss Islington (bot)
3fc45e6c4e
[3.12] gh-113625: Align object addresses in the Descriptor HowTo Guide (GH-113894) (#113922)
gh-113625: Align object addresses in the Descriptor HowTo Guide (GH-113894)
(cherry picked from commit 901a971e16)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2024-01-10 18:32:54 +01:00
Miss Islington (bot)
082998c3af
[3.12] gh-113664: Improve style of Big O notation (GH-113695) (GH-113909)
Use cursive to make it looking like mathematic formulas.
(cherry picked from commit a8629816c6)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-01-10 13:08:08 +00:00
Miss Islington (bot)
159e3db1f7
[3.12] GH-113661: unittest runner: Don't exit 5 if tests were skipped (GH-113856) (#113875)
GH-113661: unittest runner: Don't exit 5 if tests were skipped (GH-113856)

The intention of exiting 5 was to detect issues where the test suite
wasn't discovered at all. If we skipped tests, it was correctly
discovered.
(cherry picked from commit 3a9096c337)

Co-authored-by: Stefano Rivera <stefano@rivera.za.net>
2024-01-09 13:34:38 -08:00
Miss Islington (bot)
9a6b99ee8b
[3.12] Simplify binomial approximation example with random.binomialvariate() (gh-113871) (gh-113872) 2024-01-09 13:24:55 -06:00
Hugo van Kemenade
7e894a4baf
[3.12] gh-101100: Fix Sphinx warnings for 2.6 port-specific deprecations (GH-113752) (#113846) 2024-01-09 11:58:55 +02:00
Miss Islington (bot)
cd87737a1d
[3.12] Docs: Link tokens in the format string grammars (GH-108184) (#113839)
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:54:07 +00:00