Commit Graph

11507 Commits

Author SHA1 Message Date
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) 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) 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
Miss Islington (bot) de97d8229c
gh-92417: `subprocess` docs: remove note on compatibility with Python <3.5 (GH-92538) (GH-92972)
(cherry picked from commit 84b86000e2)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-05-19 17:56:04 +02:00
Miss Islington (bot) 02fe22576e
gh-92417: `fractions`, `decimal`: Improve docs for alternative constructor methods (GH-92421) (GH-92970)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 090df844ea)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-05-19 17:45:12 +02:00
Miss Islington (bot) a2d6e6c206
gh-92417: `socket` docs: remove references to Python <3.3 (GH-92544) (GH-92968)
(cherry picked from commit 639b62c9c4)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-05-19 17:42:07 +02:00
Miss Islington (bot) 54653b5005
gh-92417: Update docs and examples of doctest.IGNORE_EXCEPTION_DETAIL for Py>=3 (GH-92502) (GH-92962)
(cherry picked from commit 97b9c1096f)
2022-05-19 17:19:34 +02:00
Miss Islington (bot) 17a62d1e59
Doc: amend ssl.PROTOCOL_SSLv2 and ssl.PROTOCOL_SSLv3 wording (GH-92634)
(cherry picked from commit 41638967a0)

Co-authored-by: Jan Brasna <1784648+janbrasna@users.noreply.github.com>
2022-05-19 02:37:57 -07:00
Miss Islington (bot) aa55985aa8
gh-87901: Remove the encoding argument from os.popen (GH-92836)
(cherry picked from commit 96f65835f8)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2022-05-18 20:12:47 -07:00
Miss Islington (bot) 849963598f
gh-92812: Align ArgumentParser.add_subparsers() docs with argument spec (GH-92814)
(cherry picked from commit f2d994da10)

Co-authored-by: 180909 <734461790@qq.com>
2022-05-18 14:25:25 -07:00
Miss Islington (bot) 65ebd923b3
gh-92780: Improve sqlite3.Connection.create_collation docs (GH-92790)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 7ee19e2715)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-05-18 04:58:57 -07:00
Miss Islington (bot) 9a61afec20
bpo-40838: document `getdoc`, `getmodule`, `getsourcefile` in `inspect` returns `None` (GH-30575)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit b86d783a4e)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2022-05-17 18:41:55 -07:00
Miss Islington (bot) da2f0c755d
re docs: fix source code link (GH-92819)
(cherry picked from commit bd30461298)

Co-authored-by: 谭九鼎 <109224573@qq.com>
2022-05-16 17:21:50 -07:00
Ezio Melotti 5b2c5ae756
[3.11] Restore default role check in `make check`. (GH-92290) (#92821)
* Restore default role check in `make check`.

* Options first, then files.

* Update `make.bat` too.

* Add a comment explaining the extra options.

* No reason to ignore the README.rst.

* Enable default-role check in sphinx-lint.

Co-authored-by: Julien Palard <julien@palard.fr>

* Update sphinx-lint default-role check.

* Fix use of the default role in the docs.

* Update make.bat to check for the default role too.

* Fix comment in make.bat.

Co-authored-by: Julien Palard <julien@palard.fr>
(cherry picked from commit 953ab07952)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-05-15 17:55:12 +02:00
Miss Islington (bot) 9a97a89b3d
gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612)
(cherry picked from commit 9f68dab3d3)

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-05-13 13:09:53 -07:00
Miss Islington (bot) 60c4bca013
Fix typo in argparse docs. (GH-92691) (#92709) 2022-05-13 09:03:03 -05:00
Miss Islington (bot) 715b070dcc
gh-92436: __future__ docs: add note on expectations for "from __future__ import annotations" (GH-92568)
(cherry picked from commit 6582c96454)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-05-12 07:37:59 -07:00
Miss Islington (bot) bf86901dc1
Fix minor documentation error in bisect docs (GH-92697)
(cherry picked from commit b3f99b69d0)

Co-authored-by: Steve Dower <steve.dower@python.org>
2022-05-11 16:13:13 -07:00
Miss Islington (bot) 5ea8a93e1a
[3.11] Fix typo in unittest.rst: addCleanupModule -> addModuleCleanup (GH-92631) (GH-92659)
(cherry picked from commit 38486ca212)


Co-authored-by: Mikhail Terekhov <termim@gmail.com>

Automerge-Triggered-By: GH:serhiy-storchaka
2022-05-11 03:49:59 -07:00
Miss Islington (bot) a9b5bc3274
Update numbers.rst (GH-31995)
(cherry picked from commit dde8a1668e)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2022-05-11 00:36:24 -07:00
Miss Islington (bot) b162f0875d
gh-91966 Document where key functions are applied in the bisect module (GH-92602) (#92667) 2022-05-11 02:06:10 -05:00
Serhiy Storchaka 5197134c1c
Revert "gh-92550 - Fix regression in `pathlib.Path.rglob()` (GH-92583)" (GH-92599)
This reverts commit a51baec9ce.
2022-05-11 07:14:40 +03:00
Miss Islington (bot) 635b62a376
[3.11] gh-76773: Update docs mentioning no-longer-supported Windows versions & features (GH-92529) (GH-92608)
(cherry picked from commit f1bbcba74f)


Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>

Automerge-Triggered-By: GH:serhiy-storchaka
2022-05-10 02:55:36 -07:00
Miss Islington (bot) e4fc347356
gh-92417: `zlib` docs, `binascii` docs: remove Python 2 compatibility notes (GH-92543) (GH-92607)
(cherry picked from commit 7c638e6405)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-05-10 12:29:59 +03:00
Miss Islington (bot) c84f547d1d
[3.11] gh-92417: `unittest.mock` docs: remove references to Python <2.6 (GH-92539) (GH-92606)
(cherry picked from commit 6823ba4a9e)


Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

Automerge-Triggered-By: GH:serhiy-storchaka
2022-05-10 02:28:20 -07:00
Miss Islington (bot) 74c094d804
bpo-13553: Document tkinter.Tk args (GH-4786)
(cherry picked from commit c56e2bb994)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2022-05-09 21:17:57 -07:00
Miss Islington (bot) a51baec9ce
gh-92550 - Fix regression in `pathlib.Path.rglob()` (GH-92583)
We could try to remedy this by taking a slice, but we then run into an issue where the empty string will match altsep on POSIX. That rabbit hole could keep getting deeper.

A proper fix for the original issue involves making pathlib's path normalisation more configurable - in this case we want to retain trailing slashes, but in other we might want to preserve `./` prefixes, or elide `../` segments when we're sure we won't encounter symlinks.

This reverts commit ea2f5bcda1.
(cherry picked from commit dcdf250d2d)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
2022-05-09 17:39:43 -07:00
Miss Islington (bot) 2f46cf637f
bpo-38056: overhaul Error Handlers section in codecs documentation (GH-15732)
* Some handlers were wrongly described as text-encoding only, but actually they can also be used in text-decoding.
* Add more description to each handler.
* Add two REPL examples.
* Add indexes for Error Handler's name.

Co-authored-by: Kyle Stanley <aeros167@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 5bc2390229)

Co-authored-by: Ma Lin <animalize@users.noreply.github.com>
2022-05-08 20:13:45 -07:00
Miss Islington (bot) cffa76d476
pdb docs: workaround for double semicolon in strings (GH-17011)
see https://github.com/gotcha/ipdb/issues/172

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 2888b1107f)

Co-authored-by: Godefroid Chapelle <gotcha@bubblenet.be>
2022-05-08 16:36:37 -07:00
Miss Islington (bot) 574d7b8d7c
bpo-39229: fix formatting in library/functions.rst (GH-17857)
Missing reference of auditing event presents error when building translated documentation
(cherry picked from commit f298ba1f27)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2022-05-08 16:34:01 -07:00
Miss Islington (bot) d6b83a3140
gh-80856: doc: reveal doctest directives (GH-92318)
* Doc: Reveal doctest directives.

* Fix whitespace.

Co-authored-by: Julien Palard <julien@palard.fr>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 7b024e3a3f)

Co-authored-by: Davide Rizzo <sorcio@gmail.com>
2022-05-08 09:33:11 -07:00
Miss Islington (bot) 8037fb708e
Fix the `versionadded` for asyncio.StreamWriter.start_tls() (GH-92378)
(cherry picked from commit 063e8ab72b)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2022-05-08 09:04:29 -07:00
Miss Islington (bot) 7c6d649c2b
gh-92417: `logging` docs: Remove warning that only applies to Python <3.2 (GH-92425)
(cherry picked from commit 318c4e91ef)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-05-08 09:04:00 -07:00
Miss Islington (bot) 6d8fd3f608
`typing.Text`: tweak deprecation notice (GH-92405)
https://github.com/python/cpython/pull/92351/filesGH-r866869469

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit bdc99a830f)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-05-08 08:36:54 -07:00
Miss Islington (bot) 29f592e6fe
[3.11] gh-92417: `asyncio` docs: `asyncio.run()` is available on all supported Python versions (GH-92419) (GH-92462)
(cherry picked from commit f4e317b304)


Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

Automerge-Triggered-By: GH:serhiy-storchaka
2022-05-08 08:30:52 -07:00
Miss Islington (bot) dfad113715
[3.11] gh-92417: `json` docs: `dict` is ordered on all supported Python versions (GH-92422) (GH-92464)
(cherry picked from commit bc098cfdb7)


Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

Automerge-Triggered-By: GH:serhiy-storchaka
2022-05-08 08:30:27 -07:00
Miss Islington (bot) c35da32cde
[3.11] gh-92417: `doctest` docs: remove references to Python <3.6 (GH-92420) (GH-92467)
(cherry picked from commit 5639ea1ef9)


Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

Automerge-Triggered-By: GH:serhiy-storchaka
2022-05-08 08:29:58 -07:00
Miss Islington (bot) eec14f42c1
[3.11] gh-92417: `stdtypes` docs: delete discussion of Python 2 differences (GH-92423) (GH-92472)
Given that 2.7 has now been end-of-life for two and a half years,
I don't think we need such a detailed explanation here anymore of
the differences between Python 2 and Python 3.
(cherry picked from commit 8efda1e7c6)


Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

Automerge-Triggered-By: GH:serhiy-storchaka
2022-05-08 08:25:26 -07:00