mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-23 09:19:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
111402 commits 6 branches 641 tags 4 GiB
Commit graph

24720 commits

Author SHA1 Message Date
Hugo van Kemenade
cfb9248cd4
Speedup: build docs in parallel (GH-92733) (GH-92850) 
(cherry picked from commit a487623c6b)
 2022-05-16 18:53:38 +02:00
Miss Islington (bot)
93d9b782cc
gh-87670: Add web.archive redirects from effbot (GH-92816) 
(cherry picked from commit 3ed1cae9ed)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
 2022-05-15 23:27:54 -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)
48f2d8de24
Document Py_ssize_t. (GH-92512) 
It fixes 252 errors from a Sphinx nitpicky run (sphinx-build -n). But
there's 8182 errors left.

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 664aa94b57)

Co-authored-by: Julien Palard <julien@palard.fr>
 2022-05-13 06:32:39 -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)
826ceab488
Doc: Update py2app link. (GH-91585) 
See: https://mail.python.org/archives/list/docs@python.org/thread/KDVFGNGGUGGPVRZT7WZYHHWXCRS2GEN7/
(cherry picked from commit b77a95f44a)

Co-authored-by: Julien Palard <julien@palard.fr>
 2022-05-09 14:28:40 -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)
ca425ac11a
gh-77521: Add link to builtin module names in modules tutorial (GH-92438) 
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 859250cc55)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
 2022-05-08 12:46:18 -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)
f40731fb51
[3.10] GH-92431: Fix footnotes in Doc/c-api/exceptions.rst (GH-92432) (GH-92470) 
* Remove redundant footnote ref: the footnote has been removed
* Fix footnote ref to match footnote
* Convert footnotes into reST footnotes: will error if missing
(cherry picked from commit 788ef54bc9)


Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Automerge-Triggered-By: GH:serhiy-storchaka
 2022-05-08 08:28:47 -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
Dong-hee Na
731d893bdf
[3.10] gh-92448: Update the documentation builder to render the GitHub issue (GH-92449). (GH-92457) 2022-05-08 22:31:40 +09:00
Miss Islington (bot)
17f3b5cbfa
gh-92368: Fix missing possessive apostrophe (GH-92397) 
* Fix missing possessive apostrophe
(cherry picked from commit a79001ee16)

Co-authored-by: gophra <105054704+gophra@users.noreply.github.com>
 2022-05-06 07:12:59 -07:00
Miss Islington (bot)
229dc17f7a
gh-92047: Py_GetVersion multi-digit minor version (GH-92047) (GH-92048) (#92330) 
(cherry picked from commit 43b135f94e)

Co-authored-by: Robert Howlett <robert@howletts.org.uk>

Co-authored-by: Robert Howlett <robert@howletts.org.uk>
 2022-05-06 14:47:09 +02:00
Miss Islington (bot)
367faf71ea
Document the lifetime of PyUnicode_AsUTF8String (GH-92325) 
The current wording implied this, but didn't state it explicitly.
(cherry picked from commit 740da8d37a)

Co-authored-by: Matt Wozniski <godlygeek@gmail.com>
 2022-05-06 02:55:01 -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)
666820cb4b
gh-87304: Improve comments in language reference for imports (GH-92164) 
(cherry picked from commit ee2205b208)

Co-authored-by: Robert Yang <35813883+robert861212@users.noreply.github.com>
 2022-05-03 15:24:03 -07: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)
864058ba86
[3.10] Fix typo in Programming FAQ (GH-92083) (GH-92148) 
I believe the word "with" was missing here.
(cherry picked from commit 2a7efa3242)


Co-authored-by: Matt Harding <majaharding@gmail.com>
 2022-05-02 10:24:49 -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)
a7d3de7fe6
gh-85679: Recommend encoding="utf-8" in tutorial (GH-91778) 
(cherry picked from commit 614420df97)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
 2022-05-02 01:45:10 -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)
8b6e5d3863
gh-89253: Add 3.10 whatsnew section for itertools.pairwise (GH-91563) 
GH-89253

[`pairwise()`](https://docs.python.org/3/library/itertools.htmlGH-itertools.pairwise) already has the 'new in python3.10'

Automerge-Triggered-By: GH:rhettinger
(cherry picked from commit 5dcfb916c7)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
 2022-04-30 15:29:09 -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