Miss Islington (bot)
a2695be91c
[3.10] Improve logging documentation with example and additional cookbook re… (GH-93644) (GH-93648)
...
(cherry picked from commit e974b3e333
2022-06-10 16:31:00 +02:00
Miss Islington (bot)
2139583bf9
Doc: Update references and examples of old, unsupported OSes and uarches (GH-92791) (GH-93639)
...
(cherry picked from commit a5ba0f4ebc
2022-06-09 16:15:49 +02:00
jacksonriley
6b9122483f
[3.10] Fix PurePath.relative_to links in the pathlib documentation (GH-93268) (GH-93590)
...
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#93268
2022-06-07 14:58:43 -07:00
Miss Islington (bot)
c7b5a2d5ea
gh-88831: In docs for asyncio.create_task, explain why strong references to tasks are needed (GH-93258) (GH-93567)
...
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 75ceae05c1
2022-06-07 12:14:25 +02:00
Miss Islington (bot)
386babebe9
gh-93391: fix typo in array docs (GH-93392) (GH-93395)
...
Fixes GH-93391
(cherry picked from commit fc694364cc
2022-06-06 19:14:04 +02:00
Miss Islington (bot)
ce057ae1e3
gh-93372: Fix typo in os.rename documentation (GH-93401) (GH-93404)
...
(cherry picked from commit e7aab7c92a
2022-06-06 19:11:18 +02:00
Miss Islington (bot)
3d19051386
📝 Make sure the phrase "constant-time compare" actually appears in the docs (GH-93396) ( #93400 )
...
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
2022-06-06 18:54:04 +02:00
Miss Islington (bot)
0b7aae88d0
Remove the execution bit to some socket-related files. (GH-93368)
...
(cherry picked from commit 5247389369
2022-06-01 00:31:31 -07:00
Miss Islington (bot)
aa06a84099
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
2022-05-29 19:03:15 -07:00
Miss Islington (bot)
9912b3d989
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
2022-05-27 12:25:21 -07:00
Miss Islington (bot)
251104f12d
[3.10] gh-92859: Doc: add info about logging.debug() calling basicConfig() (GH-93063) (GH-93150)
2022-05-23 20:45:44 +01:00
Miss Islington (bot)
936eefcb82
gh-92994: Clarify importlib "check" example (GH-92995)
...
Fixes GH-92994
(cherry picked from commit e39cd76561
2022-05-22 19:11:58 -07:00
Miss Islington (bot)
619a67cc06
gh-73137: Added sub-subsection headers for flags in re (GH-93000)
...
Fixes GH-73137
(cherry picked from commit b7a6610bc8
2022-05-22 19:06:54 -07:00
Miss Islington (bot)
54b5e4da8a
gh-91362: reword pickle docs to account for nested classes (GH-92429)
...
Fixes GH-91362
(cherry picked from commit f9d6c59917
2022-05-21 08:10:56 -07:00
Miss Islington (bot)
3c2a1e7f4a
[3.10] gh-72073: Add Windows case in pathlib.rename (GH-93002) (GH-93029)
...
GH-72073
https://docs.python.org/3.12/library/pathlib.htmlGH-pathlib.Path.rename
(cherry picked from commit f51ed04c66
2022-05-20 15:44:07 -07:00
Miss Islington (bot)
4d363d8989
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
2022-05-20 02:21:29 -07:00
Miss Islington (bot)
5d7f3dc3dc
bpo-46879: Fix incorrect sphinx object names in doc (GH-31615) (GH-92975)
...
(cherry picked from commit 2cdd57f119
2022-05-19 17:57:46 +02:00
Miss Islington (bot)
3d47035686
gh-92417: subprocess docs: remove note on compatibility with Python <3.5 (GH-92538) (GH-92973)
...
(cherry picked from commit 84b86000e2
2022-05-19 17:49:13 +02:00
Miss Islington (bot)
93ebac7a79
gh-92417: fractions, decimal: Improve docs for alternative constructor methods (GH-92421) (GH-92971)
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 090df844ea
2022-05-19 17:45:30 +02:00
Miss Islington (bot)
ebf3f12c38
gh-92417: socket docs: remove references to Python <3.3 (GH-92544) (GH-92969)
...
(cherry picked from commit 639b62c9c4
2022-05-19 17:44:31 +02:00
Miss Islington (bot)
4e289e20e2
gh-92417: Update docs and examples of doctest.IGNORE_EXCEPTION_DETAIL for Py>=3 (GH-92502) (GH-92963)
...
(cherry picked from commit 97b9c1096f
2022-05-19 17:19:53 +02:00
Miss Islington (bot)
3e534b464a
Doc: amend ssl.PROTOCOL_SSLv2 and ssl.PROTOCOL_SSLv3 wording (GH-92634)
...
(cherry picked from commit 41638967a0
2022-05-19 02:40:39 -07:00
Miss Islington (bot)
17524b084b
gh-92812: Align ArgumentParser.add_subparsers() docs with argument spec (GH-92814)
...
(cherry picked from commit f2d994da10
2022-05-18 14:30:00 -07:00
Miss Islington (bot)
ed75d2183f
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
2022-05-18 05:49:15 -07:00
Miss Islington (bot)
94e21cf229
gh-92780: Improve sqlite3.Connection.create_collation docs (GH-92790)
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 7ee19e2715
2022-05-18 05:05:24 -07:00
thueringa
56e9fb3e3b
Fix typo in argparse docs. (GH-92691) ( #92729 )
2022-05-13 16:09:06 -05:00
Miss Islington (bot)
597ff24188
gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612)
...
(cherry picked from commit 9f68dab3d3
2022-05-13 13:11:05 -07:00
Miss Islington (bot)
5d62759f98
gh-92436: __future__ docs: add note on expectations for "from __future__ import annotations" (GH-92568)
...
(cherry picked from commit 6582c96454
2022-05-12 07:42:57 -07:00
Miss Islington (bot)
9f29bdd8f0
Fix minor documentation error in bisect docs (GH-92697)
...
(cherry picked from commit b3f99b69d0
2022-05-11 16:12:17 -07:00
Miss Islington (bot)
7a84ea4ec1
[3.10] Fix typo in unittest.rst: addCleanupModule -> addModuleCleanup (GH-92631) (GH-92660)
...
(cherry picked from commit 38486ca212
2022-05-11 03:50:00 -07:00
Miss Islington (bot)
d435ebd39e
gh-91966 Document where key functions are applied in the bisect module (GH-92602) ( #92666 )
2022-05-11 02:06:42 -05:00
Miss Islington (bot)
dd0e8a62df
[3.10] gh-76773: Update docs mentioning no-longer-supported Windows versions & features (GH-92529) (GH-92609)
...
(cherry picked from commit f1bbcba74f
2022-05-10 02:28:22 -07:00
Miss Islington (bot)
5ed2f11834
bpo-13553: Document tkinter.Tk args (GH-4786)
...
(cherry picked from commit c56e2bb994
2022-05-09 21:27:37 -07:00
Miss Islington (bot)
cd11068712
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
2022-05-08 20:16:26 -07:00
Miss Islington (bot)
158579654d
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
2022-05-08 16:39:09 -07:00
Miss Islington (bot)
6679fdf4f0
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
2022-05-08 16:38:47 -07:00
Miss Islington (bot)
1dbf69979f
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
2022-05-08 09:32:20 -07:00
Miss Islington (bot)
15cb6e8b8b
gh-92417: logging docs: Remove warning that only applies to Python <3.2 (GH-92425)
...
(cherry picked from commit 318c4e91ef
2022-05-08 09:03:09 -07:00
Miss Islington (bot)
e363034752
[3.10] gh-92417: asyncio docs: asyncio.run() is available on all supported Python versions (GH-92419) (GH-92463)
...
(cherry picked from commit f4e317b304
2022-05-08 08:30:43 -07:00
Miss Islington (bot)
2164b5bad7
[3.10] gh-92417: json docs: dict is ordered on all supported Python versions (GH-92422) (GH-92465)
...
(cherry picked from commit bc098cfdb7
2022-05-08 08:30:18 -07:00
Miss Islington (bot)
45ed69b200
[3.10] gh-92417: doctest docs: remove references to Python <3.6 (GH-92420) (GH-92468)
...
(cherry picked from commit 5639ea1ef9
2022-05-08 08:29:50 -07:00
Miss Islington (bot)
a7d869a2ea
[3.10] gh-77630: Change Charset to charset (GH-92439) (GH-92476)
...
(cherry picked from commit 8f29318079
2022-05-08 08:28:06 -07:00
Miss Islington (bot)
8c42fefa39
[3.10] gh-92417: stdtypes docs: delete discussion of Python 2 differences (GH-92423) (GH-92473)
...
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
2022-05-08 08:26:06 -07:00
Miss Islington (bot)
80ce70110b
gh-92417: typing docs: from __future__ import annotations can be used in all supported Python versions (GH-92418)
...
(cherry picked from commit e5b4bd4d60
2022-05-08 08:04:18 -07:00
Miss Islington (bot)
bb2dcf1c79
gh-92223: Remove pre-Python 3.7 alternative in asyncio docs (GH-92224)
...
(cherry picked from commit d1b2e989be
2022-05-04 17:30:54 -07:00
Jelle Zijlstra
31d9a88ca8
[3.10] Improve the typing docs (GH-92264) ( #92270 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.
(cherry picked from commit 27e3665715
2022-05-03 16:41:39 -06:00
Miss Islington (bot)
5f40cb85c2
bpo-46586: Fix more erroneous doc links to builtins (GH-31429)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Éric <merwok@netwok.org>
(cherry picked from commit cc6ae4f483
2022-05-02 15:51:33 -07:00
Miss Islington (bot)
f44e629a57
bpo-6686: Replace String with Bytes in xml.sax.handler documentation (GH-30612)
...
(cherry picked from commit 32e4f450af
2022-05-02 15:44:07 -07:00
Miss Islington (bot)
d851f37b88
importlib docs: Update importlib.abc hierarchy (GH-31113)
...
Fixed some inconsistencies in the text about relationships
(cherry picked from commit 5f45a9d3c3
2022-05-02 13:48:59 -07:00
Thaddeus1499
c8ab1633fc
[3.10] bpo-43504: Remove effbot urls (GH-26308) ( #92161 )
...
* [3.10] Remove effbot urls (GH-26308).
(cherry picked from commit e9f66aedf4
2022-05-02 12:21:51 -06:00
