Miss Islington (bot)
936eefcb82
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: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 )
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
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 )
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
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 )
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Automerge-Triggered-By: GH:brettcannon
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 )
Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
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 )
Co-authored-by: Ćukasz Langa <lukasz@langa.pl>
Co-authored-by: Martin Fischer <martin@push-f.com>
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 )
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
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 )
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
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 )
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
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 )
Co-authored-by: Jan Brasna <1784648+janbrasna@users.noreply.github.com>
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 )
Co-authored-by: 180909 <734461790@qq.com>
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 )
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
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 )
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
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 )
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
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 )
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
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 )
Co-authored-by: Steve Dower <steve.dower@python.org>
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 )
Co-authored-by: Mikhail Terekhov <termim@gmail.com>
Automerge-Triggered-By: GH:serhiy-storchaka
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 )
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Automerge-Triggered-By: GH:serhiy-storchaka
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 )
Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
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 )
Co-authored-by: Ma Lin <animalize@users.noreply.github.com>
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 )
Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
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 )
Co-authored-by: Godefroid Chapelle <gotcha@bubblenet.be>
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 )
Co-authored-by: Davide Rizzo <sorcio@gmail.com>
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 )
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
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 )
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Automerge-Triggered-By: GH:serhiy-storchaka
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 )
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Automerge-Triggered-By: GH:serhiy-storchaka
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 )
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Automerge-Triggered-By: GH:serhiy-storchaka
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 )
Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
Automerge-Triggered-By: GH:serhiy-storchaka
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 )
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Automerge-Triggered-By: GH:serhiy-storchaka
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 )
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
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 )
Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
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 )
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
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 )
Co-authored-by: Meer Suri <46469858+meersuri@users.noreply.github.com>
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 )
Co-authored-by: Yassir Karroum <ukarroum17@gmail.com>
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 )
Co-authored-by: David Gilbertson <gilbertson.david@gmail.com>
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 )
Co-authored-by: E-Paine <63801254+E-Paine@users.noreply.github.com>
2022-05-02 12:21:51 -06:00
Miss Islington (bot)
bab4d0bb16
gh-91783: Document security considerations for shutil.unpack_archive (GH-91844)
...
(cherry picked from commit 4b297a9ffd )
Co-authored-by: Sam Ezeh <sam.z.ezeh@gmail.com>
2022-05-02 10:34:59 -07:00
Miss Islington (bot)
0e9927b6b0
gh-92082: contextlib docs: Change aclosing from a class to a function for consistency (GH-92155)
...
Signed-off-by: prwatson <prwatson@redhat.com>
(cherry picked from commit 958f21c5cd )
Co-authored-by: Thaddeus1499 <104600742+Thaddeus1499@users.noreply.github.com>
2022-05-02 09:37:10 -07:00
Miss Islington (bot)
446cc03730
gh-88546: glob.glob docs: Make new paragraph for emphasis and reordered sentence (GH-91614)
...
(cherry picked from commit b9ab6cea08 )
Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-05-02 08:35:37 -07:00
Miss Islington (bot)
9941640041
asyncio.subprocess: Fix a typo in doc (GH-92030)
...
Remove a confusion for read method in asyncio-subprocess doc for stderr StreamReader instance
(cherry picked from commit bb857a96ef )
Co-authored-by: Harsh <65716674+Harsh-br0@users.noreply.github.com>
2022-05-02 08:18:01 -07:00
Miss Islington (bot)
9ce39cc9f2
gh-85133: os docs: Add that getenv uses os.environ (GH-91874)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit b25352a5c0 )
Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-05-02 07:58:09 -07:00
Miss Islington (bot)
bba721d0fa
gh-84714: Add behavior if dst file exists (GH-91867)
...
(cherry picked from commit 9166ace805 )
Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-05-02 07:51:07 -07:00
Miss Islington (bot)
e7de543219
typing docs: Add example for async functions (GH-20386)
...
Fixes python/typingGH-424
(cherry picked from commit 9588f880a2 )
Co-authored-by: Sam Bull <aa6bs0@sambull.org>
2022-04-30 21:55:58 -07:00
Miss Islington (bot)
a48d31f204
gh-81488: Add recursive wording for issubclass docs (GH-92087)
...
(cherry picked from commit 1066ecb970 )
Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-04-30 21:21:51 -07:00
Miss Islington (bot)
31e35bef22
gh-91611: Use example.com for documentation, not mydomain.com (GH-91613)
...
example.com is reserved by the IANA as special-use domain name for documentation
purposes. The domain names are used widely in books, tutorials, sample network
configurations, and generally as examples for the use of domain name.
On the other hand, mydomain.com is real Domain Name Registration service.
(cherry picked from commit ea39246782 )
Co-authored-by: Motoki Naruse <motoki@naru.se>
2022-04-30 21:03:11 -07:00
Miss Islington (bot)
335aae1950
gh-87801: Add run() to subprocess.CalledProcessError description (GH-91628)
...
(cherry picked from commit 567be058b4 )
Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-04-30 14:51:45 -07:00
Miss Islington (bot)
cfcda0acf2
gh-87192: Update wording for fcntl 'Changed in' (GH-91658)
...
(cherry picked from commit d7eb1ffbe8 )
Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-04-30 14:44:08 -07:00