Commit Graph

25372 Commits

Author SHA1 Message Date
Miss Islington (bot) 536af65e96
Change list to view object (GH-93661)
(cherry picked from commit 5d8e7a1240)

Co-authored-by: Pamela Fox <pamela.fox@gmail.com>
2022-06-11 04:20:52 -07:00
Miss Islington (bot) 2e0e3ce0a1
gh-86404: [doc] A make sucpicious false positive. (GH-93710)
(cherry picked from commit bc3b31ea77)

Co-authored-by: Julien Palard <julien@palard.fr>
2022-06-11 04:06:44 -07:00
Miss Islington (bot) 36ece2effb
gh-90153: whatsnew: "z" option in format spec (GH-93624)
Add what's new entry for PEP 682 in Python 3.11.
(cherry picked from commit 010284b46b)

Co-authored-by: John Belmonte <john@neggie.net>
2022-06-11 03:14:24 -07:00
Miss Islington (bot) 3a202de3bb
gh-91317: Document that Path does not collapse initial `//` (GH-32193)
Documentation for `pathlib` says:

> Spurious slashes and single dots are collapsed, but double dots ('..') are not, since this would change the meaning of a path in the face of symbolic links:

However, it omits that initial double slashes also aren't collapsed.

Later, in documentation of `PurePath.drive`, `PurePath.root`, and `PurePath.name` it mentions UNC but:

- this abbreviation says nothing to a person who is unaware about existence of UNC (Wikipedia doesn't help either by [giving a disambiguation page](https://en.wikipedia.org/wiki/UNC))
- it shows up only if a person needs to use a specific property or decides to fully learn what the module provides.

For context, see the BPO entry.
(cherry picked from commit 78f1a43694)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2022-06-10 16:07:19 -07:00
Miss Islington (bot) 62cae22c0d
gh-93391: fix typo in `array` docs (GH-93392) (GH-93394)
Fixes GH-93391

(cherry picked from commit fc694364cc)

Co-authored-by: ynfle <23086821+ynfle@users.noreply.github.com>
2022-06-10 16:12:51 +02:00
Miss Islington (bot) cc6149fe15
📝 Make sure the phrase "constant-time compare" actually appears in the docs (GH-93396) (GH-93399)
This is purely for SEO as this is the actual generic name for this kind of method and it currently does not appear in a Google search for "python constant time compare". Not creating an issue or setting this up for backports as its trivial (I think) and not a functional change.
(cherry picked from commit 8241a6971e)

Co-authored-by: Noah Kantrowitz <noah@coderanger.net>
2022-06-10 16:11:15 +02:00
Miss Islington (bot) f0a89e6507
gh-93372: Fix typo in os.rename documentation (GH-93401) (GH-93403)
(cherry picked from commit e7aab7c92a)

Co-authored-by: Wei-Ting Yang <74453331+Yang-Wei-Ting@users.noreply.github.com>
2022-06-10 16:10:14 +02:00
Miss Islington (bot) 25444124e3
gh-87961: Remove outdated notes from functions that aren't in the Limited API (GH-93581) (GH-93604)
Nowadays everything that *is* in the Limited API has a note added
automatically.
These notes could mislead people to think that these functions
could never be added to the limited API. Remove them.

(cherry picked from commit 2c3fe5eeb2)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2022-06-10 16:04:23 +02:00
Miss Islington (bot) 7bfeb8a606
[3.11] Improve logging documentation with example and additional cookbook re… (GH-93644) (GH-93647) 2022-06-09 17:28:34 +01:00
Miss Islington (bot) 92f8786ef8
Doc: Update references and examples of old, unsupported OSes and uarches (GH-92791) (GH-93638)
(cherry picked from commit a5ba0f4ebc)

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-06-09 16:15:33 +02:00
Miss Islington (bot) f26d1b5b53
Fix `PurePath.relative_to` links in the pathlib documentation. (GH-93268)
These are currently broken as they refer to :meth:`Path.relative_to` rather than :meth:`PurePath.relative_to`, and `relative_to` is a method on `PurePath`.
(cherry picked from commit 8ef7929baf)

Co-authored-by: jacksonriley <52106215+jacksonriley@users.noreply.github.com>
2022-06-07 12:11:10 -07:00
Miss Islington (bot) 2a24421054
gh-88831: In docs for asyncio.create_task, explain why strong references to tasks are needed (GH-93258) (GH-93566)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 75ceae05c1)

Co-authored-by: Andreas Grommek <76997441+agrommek@users.noreply.github.com>
2022-06-07 12:14:06 +02:00
Miss Islington (bot) 07c3cbad95
gh-86986: bump min sphinx version to 3.2 (GH-93337) (GH-93561)
(cherry picked from commit 57e8ee7086)

Co-authored-by: Davide Rizzo <sorcio@gmail.com>
2022-06-07 10:21:47 +02:00
Miss Islington (bot) e139dee1f7
Fix contributor name in WhatsNew 3.11 (GH-93556)
(cherry picked from commit 74039330f2)

Co-authored-by: Samodya Abeysiriwardane <379594+sransara@users.noreply.github.com>
2022-06-06 21:49:47 -07:00
Miss Islington (bot) fd4dad5cca
[docs] fix some asyncio.Barrier.wait docs grammar (GH-93552) (GH-93553)
(cherry picked from commit 46fde1feb5)

Co-authored-by: Thomas Grainger <tagrain@gmail.com>
2022-06-06 20:51:13 +02:00
Miss Islington (bot) a712c4b26c
Remove action=None kwarg from Barrier docs (GH-93538) (GH-93551)
(cherry picked from commit 71c8f96971)

Co-authored-by: Thomas Grainger <tagrain@gmail.com>
2022-06-06 20:10:12 +02:00
Miss Islington (bot) f46e30f9d4
gh-83728: Add hmac.new default parameter deprecation (GH-91939) (GH-93544)
(cherry picked from commit 56b5daf159)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-06-06 19:09:51 +02:00
Miss Islington (bot) e8404f46b3
asyncio.Barrier docs: Fix typo (GH-93371)
taks -> tasks
(cherry picked from commit 8584981a58)

Co-authored-by: Omer Katz <omer.katz@omerkatz.com>
2022-06-06 07:54:44 -07:00
Miss Islington (bot) fae93ab163
[3.11] gh-68966: Make mailcap refuse to match unsafe filenames/types/params (GH-91993) (GH-93458)
(cherry picked from commit b9509ba7a9)


Co-authored-by: Petr Viktorin <encukou@gmail.com>

Automerge-Triggered-By: GH:encukou
2022-06-03 08:25:58 -07:00
Ken Jin 74b91b1763
[3.11] gh-93433: Fix dis doc example output (GH-93434) (GH-93460)
(cherry picked from commit debf4c1ec5)
2022-06-03 21:26:43 +08:00
Miss Islington (bot) d779e5d16e
Remove the execution bit to some socket-related files. (GH-93368)
(cherry picked from commit 5247389369)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-06-01 00:35:15 -07:00
Miss Islington (bot) 00f8fe9564
[3.11] gh-91162: Fix substitution of unpacked tuples in generic aliases (GH-92335) (#92484)
* gh-91162: Fix substitution of unpacked tuples in generic aliases (GH-92335)
(cherry picked from commit 9d25db9db1)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

* Regenerate ABI file

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Pablo Galindo <pablogsal@gmail.com>
2022-06-01 03:13:27 +01:00
Miss Islington (bot) 3a62701452
Remove VOC reference (93333)
VOC has been archived by the BeeWare project, and they are instead
embedding CPython, rather than transpiling to Java bytecode.
(cherry picked from commit bb900712a5)

Co-authored-by: Carl Bordum Hansen <carl@bordum.dk>
2022-05-31 10:46:37 -07:00
Miss Islington (bot) cc31cfc25e
bpo-42272: fix misleading warning filter message/module docs (GH-23172)
* bpo-42272: improve message/module warning filter docs

"The Warnings Filter" section of the warnings module documentation
describes the message and module filters as "a string containing a
regular expression".  While that is true when they are arguments to the
filterwarnings function, it is not true when they appear in -W or
$PYTHONWARNINGS where they are matched literally (after stripping any
starting/ending whitespace).  Update the documentation to note when they
are matched literally.  Also clarify that module matches the
"fully-qualified module name", rather than "module name" which is
ambiguous.

skip news (since this is a doc fix)

Signed-off-by: Kevin Locke <kevin@kevinlocke.name>

* bpo-42272: remove bad submodule warning filter doc

The `error:::mymodule[.*]` example in the "Describing Warning Filters"
section of the warnings module documentation does not behave as the
comment describes.  Since the module portion of the filter string is
interpreted literally, it would match a module with a fully-qualified
name that is literally `mymodule[.*]`.

Unfortunately, there is not a way to match '"module" and any subpackages
of "mymodule"' as documented, since the module part of a filter string
is matched literally.  Instead, update the filter and comment to match
only "mymodule".

skip news (since this is a doc fix)

Signed-off-by: Kevin Locke <kevin@kevinlocke.name>

* bpo-42272: add warning filter doc changes to NEWS

Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
(cherry picked from commit 8136606769)

Co-authored-by: Kevin Locke <kevin@kevinlocke.name>
2022-05-29 19:04:21 -07:00
Miss Islington (bot) 624fc61c83
gh-92240 : Include release dates for "What's New In Python 3.X" (GH-92937)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
(cherry picked from commit 877ad7b3b2)

Co-authored-by: georgically <40323509+georgically@users.noreply.github.com>
2022-05-28 20:38:48 -07:00
Miss Islington (bot) 48647d00bf
gh-92727: Add example of named group in doc for re.Match.__getitem__ (GH-92730)
(cherry picked from commit 642d1fa81f)

Co-authored-by: Baptiste Mispelon <bmispelon@gmail.com>
2022-05-28 11:28:52 -07:00
Eric Snow 36374251aa
[3.11] bpo-40514: Drop EXPERIMENTAL_ISOLATED_SUBINTERPRETERS (gh-93185) (GH-93306)
(cherry picked from commit caa279d6fd)

This was added for bpo-40514 (gh-84694) to test out a per-interpreter GIL.  However, it has since proven unnecessary to keep the experiment in the repo.  (It can be done as a branch in a fork like normal.)  So here we are removing:

* the configure option
* the macro
* the code enabled by the macro

Automerge-Triggered-By: GH:ericsnowcurrently
2022-05-27 17:56:30 -07:00
Miss Islington (bot) 3f7abff97b
gh-91243: Document Required and NotRequired (GH-93173)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 711eda7dec)

Co-authored-by: David Foster <david@dafoster.net>
2022-05-27 15:25:50 -07:00
Miss Islington (bot) 34bd36c99f
gh-77024: test.support: Improve documentation (GH-92513)
This is a rework of GH-5774 on current main. I was a bit more
conservative in making changes than the original PR.

See @csabella's comments on issue GH-77024 and the discussion
on GH-5774 for explanations of several of the changes.

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 8995177030)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-05-27 07:31:35 -07:00
Miss Islington (bot) 83940c0766
gh-90817: Deprecate explicitly locale.resetlocale() (GH-93196)
The function was already deprecated in Python 3.11 since it calls
locale.getdefaultlocale() which was deprecated in Python 3.11.
(cherry picked from commit bf58cd01b3)

Co-authored-by: Victor Stinner <vstinner@python.org>
2022-05-25 13:29:58 -07:00
Miss Islington (bot) 74b205b3eb
gh-92728: Restore re.template, but deprecate it (GH-93161)
Revert "bpo-47211: Remove function re.template() and flag re.TEMPLATE (GH-32300)"

This reverts commit b09184bf05.
(cherry picked from commit 16a7e4a0b7)

Co-authored-by: Miro Hrončok <miro@hroncok.cz>
2022-05-24 23:32:20 -07:00
Miss Islington (bot) fd35be511a
Doc: No need to use rst syntax in code comments. (GH-93102)
And it raises `make suspicious` false positives.
(cherry picked from commit e739ff1416)

Co-authored-by: Julien Palard <julien@palard.fr>
2022-05-23 15:00:34 -07:00
Miss Islington (bot) cea65730a7
gh-92859: Doc: add info about logging.debug() calling basicConfig() (GH-93063) (GH-93151)
(cherry picked from commit 2176898308)
2022-05-23 20:45:03 +01:00
Miss Islington (bot) fc31e2de3c
gh-92913: Fix typos in documentation (GH-93129)
(cherry picked from commit 6a6f823ea7)

Co-authored-by: Steve Dower <steve.dower@python.org>
2022-05-23 09:54:36 -07:00
Miss Islington (bot) 9a2fe42b11
gh-89158: Add some REPL secondary prompt markers (GH-93073)
This fixes an issue on tutorial/classes.rst section 9.4 where the example "class Warehouse"
was truncated when pressing the >>> button to hide the prompts and output.
(cherry picked from commit 88f0d0c1e8)

Co-authored-by: Nicolas Haller <nicolas@haller.im>
2022-05-22 22:18:09 -07:00
Miss Islington (bot) 83aa0d1822
gh-73137: Added sub-subsection headers for flags in re (GH-93000)
Fixes GH-73137
(cherry picked from commit b7a6610bc8)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-05-22 19:14:11 -07:00
Miss Islington (bot) 247e059de3
gh-92994: Clarify importlib "check" example (GH-92995)
Fixes GH-92994
(cherry picked from commit e39cd76561)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-05-22 19:10:57 -07:00
Miss Islington (bot) 25334ca082
binascii docs: strict_mode parameter is keyword-only (GH-93055)
See 35b98e38b6

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
(cherry picked from commit ac718d357a)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-05-22 19:05:09 -07:00
Miss Islington (bot) a86ad12399
termios docs: fix indentation (GH-93080)
(cherry picked from commit ea5918e932)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-05-22 16:11:36 -07:00
Miss Islington (bot) 09c3dff3ba
gh-91362: reword pickle docs to account for nested classes (GH-92429)
Fixes GH-91362
(cherry picked from commit f9d6c59917)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-05-21 08:08:59 -07:00
Miss Islington (bot) f2aeb3f6f7
gh-71223: Improve rendering of some references in the docs (GH-93041)
For example, instead of "eval()uated" (link from "eval()")
show "evaluated" (link from the whole word).
(cherry picked from commit 7f835923c1)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-05-21 00:49:36 -07:00
Miss Islington (bot) b97e28f1c2
gh-93019: Fix markup in zipfile.rst (GH-93025)
Fixes GH-93019
(cherry picked from commit 2fadde7e66)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-05-20 21:52:32 -07:00
Miss Islington (bot) b52e44d933
Take advantage of math.comb() in the nth_combination() recipe (GH-93027) (#93032) 2022-05-20 18:34:30 -05:00
Miss Islington (bot) 61dfe37429
[3.11] gh-72073: Add Windows case in pathlib.rename (GH-93002) (GH-93028)
GH-72073

https://docs.python.org/3.12/library/pathlib.htmlGH-pathlib.Path.rename
(cherry picked from commit f51ed04c66)


Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>

Automerge-Triggered-By: GH:brettcannon
2022-05-20 15:42:28 -07:00
Miss Islington (bot) 24223ec82a
gh-92611: Clarify planned removal version in PEP 594-deprecated modules (GH-92793) (GH-93026)
As discussed in GH-92611 and GH-92564 and as a followup to PR GH-92612 , this 3.11+ only PR uses the proper `deprecated-removed` role for the modules deprecated by PEP 593 (PEP-594) to clearly indicate to users that a removal version is planned and what it is, so they can prepare accordingly or voice any unanticipated impacts.

Related to GH-92792 ; if we decide to backport that PR, the upgrade to using `deprecated-removed` on those functions can be moved to this one.
(cherry picked from commit 31fa41ed68)

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-05-20 15:33:12 -07:00
Miss Islington (bot) 6a3a6ba7a2
gh-91860: documentation for typing.dataclass_transform (GH-92768)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit f20a6a54fb)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-05-20 08:01:44 -07:00
Miss Islington (bot) 6814ab7907
Doc: add missing manpage and title references in tkinter docs (GH-29008)
- add bind(3tk) manpage markup
- add Tcl/Tk book reference markup
(cherry picked from commit 0e12781ad9)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2022-05-20 01:34:21 -07:00
Miss Islington (bot) 4eb2f40756
gh-92913: Clarify changes to PyInitConfig.module_search_paths[_set] fields (GH-92980)
(cherry picked from commit 403d16fa28)

Co-authored-by: Steve Dower <steve.dower@python.org>
2022-05-19 13:13:15 -07:00
Miss Islington (bot) 37d60c0255
gh-92417: `importlib` docs: remove references to unsupported Python versions (GH-92424) (GH-92979)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 70aa1b9b91)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-05-19 18:11:25 +02:00
Miss Islington (bot) 27302ae2df
bpo-46879: Fix incorrect sphinx object names in doc (GH-31615) (GH-92974)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 2cdd57f119)

Co-authored-by: Martin Fischer <martin@push-f.com>
2022-05-19 17:56:59 +02:00