Commit graph

24099 commits

Author SHA1 Message Date
Miss Islington (bot)
f253cf469d
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 07:10:10 -07:00
thueringa
256c6d05e2
Fix typo in argparse docs. (GH-92691) (#92731) 2022-05-13 09:01:30 -05:00
Jelle Zijlstra
f6bd1bd19a
[3.9] gh-92436: __future__ docs: add note on expectations for "from __future__ import annotations" (GH-92568). (#92726)
(cherry picked from commit 6582c96454)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-05-12 14:12:28 -07:00
Miss Islington (bot)
3f2113dd08
[3.9] Fix typo in unittest.rst: addCleanupModule -> addModuleCleanup (GH-92631) (GH-92661)
(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)
7534c50985
[3.9] gh-76773: Update docs mentioning no-longer-supported Windows versions & features (GH-92529) (GH-92610)
(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:24 -07:00
Miss Islington (bot)
b7a87861de
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:20:37 -07:00
Miss Islington (bot)
249be828e4
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:31:12 -07:00
Miss Islington (bot)
ad82e1244e
gh-92417: asyncio docs: asyncio.run() is available on all supported Python versions (GH-92419)
(cherry picked from commit f4e317b304)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-05-09 09:49:25 -07:00
Miss Islington (bot)
03aa75221b
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:20:07 -07:00
Miss Islington (bot)
bf5fc2adb7
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:44:33 -07:00
Miss Islington (bot)
0dd32b52c7
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:50:28 -07:00
Miss Islington (bot)
580163d6a9
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:07:49 -07:00
Miss Islington (bot)
baed0c31ee
[3.9] gh-92417: json docs: dict is ordered on all supported Python versions (GH-92422) (GH-92466)
(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:08 -07:00
Miss Islington (bot)
7fd4e6502e
[3.9] GH-92431: Fix footnotes in Doc/c-api/exceptions.rst (GH-92432) (GH-92471)
* 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:37 -07:00
Miss Islington (bot)
bab6954482
[3.9] gh-77630: Change Charset to charset (GH-92439) (GH-92477)
(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:18 -07:00
Miss Islington (bot)
0cd0d6bf48
[3.9] gh-92417: stdtypes docs: delete discussion of Python 2 differences (GH-92423) (GH-92474)
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:50 -07:00
Miss Islington (bot)
731e844b17
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:06 -07:00
Dong-hee Na
480234488c
[3.9] gh-92448: Update the documentation builder to render the GitHub issue. (GH-92449). (GH-92458) 2022-05-08 22:21:05 +09:00
Miss Islington (bot)
4a2337fe33
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:13:43 -07:00
Miss Islington (bot)
326f6ed059
gh-92047: Py_GetVersion multi-digit minor version (GH-92047) (GH-92048) (#92329)
(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:30 +02:00
Miss Islington (bot)
60407e8a19
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:56:55 -07:00
Miss Islington (bot)
d82a769a1d
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:36:04 -07:00
Jelle Zijlstra
187cb95088
[3.9] Improve the typing docs (GH-92264) (#92271)
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:47 -06:00
Miss Islington (bot)
696d868d19
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:28:09 -07:00
Jelle Zijlstra
92d2615d00
[3.9] bpo-46586: Fix more erroneous doc links to builtins (GH-31429) (#92199)
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-03 06:08:55 -06:00
Miss Islington (bot)
3fe4e4602d
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:45:55 -07:00
Thaddeus1499
e48da72647
[3.9] Remove effbot urls (GH-26308). (#92162)
(cherry picked from commit e9f66aedf4)

Co-authored-by: E-Paine <63801254+E-Paine@users.noreply.github.com>
2022-05-02 12:22:05 -06:00
Miss Islington (bot)
d113674b3e
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:36:05 -07:00
Miss Islington (bot)
9b7cdfdf35
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:33:39 -07:00
Miss Islington (bot)
0c011cc6c2
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:20:25 -07:00
Miss Islington (bot)
090a0f6ffb
Fix typo in Programming FAQ (GH-92083)
I believe the word "with" was missing here.
(cherry picked from commit 2a7efa3242)

Co-authored-by: Matt Harding <majaharding@gmail.com>
2022-05-02 08:20:09 -07:00
Miss Islington (bot)
5a0f3ae22f
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 08:08:40 -07:00
Miss Islington (bot)
cafcb2cdca
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:54:12 -07:00
slateny
28cd98f352
[3.9] gh-81488: Add recursive wording for issubclass docs (GH-92087) (#92131)
(cherry picked from commit 1066ecb970)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-05-02 08:36:19 -06:00
Miss Islington (bot)
d05ee916c1
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:45 -07:00
Miss Islington (bot)
fcbff77b26
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:59:26 -07:00
Miss Islington (bot)
cef3a994c7
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:02:51 -07:00
Miss Islington (bot)
2e84e97656
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:54:58 -07:00
Miss Islington (bot)
2830543247
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:45:02 -07:00
Miss Islington (bot)
2c859e3d58
gh-85864: io docs: Add missing position-only parameters (GH-91950)
(cherry picked from commit 3a8e2b6e65)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-04-30 08:42:55 -07:00
Miss Islington (bot)
869a894338
sorting howto: Add clarification on < using __lt__ (GH-92010)
(cherry picked from commit 53ca774497)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-04-29 15:26:51 -07:00
Miss Islington (bot)
0e16105af6
Add note that headers added via urllib.request.add_header are added to redirected requests (GH-30708) (#92005)
(cherry picked from commit f348154c8f)

Co-authored-by: Ashwin Ramaswami <aramaswamis@gmail.com>

Co-authored-by: Ashwin Ramaswami <aramaswamis@gmail.com>
2022-04-27 16:28:10 -06:00
Miss Islington (bot)
35a4eb299a
gh-84459: Make wording more specific for Path.replace (GH-91853)
GH-84459
(cherry picked from commit 161dff7e10)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-04-27 15:20:53 -07:00
Miss Islington (bot)
24ce12366f
gh-68966: Document mailcap deprecation in Python 3.11 (GH-91971)
(cherry picked from commit 80de0273c0)
(cherry picked from commit a36d97e3f1)

Co-authored-by: Victor Stinner <vstinner@python.org>
2022-04-27 02:59:32 -07:00
Ezio Melotti
38be31e61e
[3.9] gh-91888: add a :gh: role to the documentation (GH-91889) (#91935)
* gh-91888: Add a :gh: role to the documentation (GH-91889).

* [3.9] gh-91888: add a `:gh:` role to the documentation (GH-91889)

* Add a new :gh:`...` role for GitHub issues.

* Fix a GitHub id to use the :gh: role.

* Add Misc/NEWS entry.

* Refactoring and rephrasing.

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>.
(cherry picked from commit f7641a2ffe)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-04-26 03:16:24 +02:00
Ezio Melotti
7f897b9626
[3.9] Update Sphinx bpo role to use redirect URI. (#91891)
* Update Sphinx bpo role to use redirect URI. (GH-32342)

* [3.9] Update Sphinx bpo role to use redirect URI. (GH-32342).
(cherry picked from commit 08cfe07950)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-04-24 23:17:48 +02:00
Jelle Zijlstra
e4f5bff140
[3.9] gh-85864: Mark positional-only args in io docs (GH-91683). (#91848)
(cherry picked from commit a3f2cf3ced)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-04-23 10:29:45 -07:00
Miss Islington (bot)
42a158b627
gh-91547: Remove "Undocumented modules" page (GH-91682)
(cherry picked from commit 254aaa7981)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-04-22 16:33:38 -07:00
Miss Islington (bot)
342b4b0648
bpo-23747: Enhance platform doc, document default behavior (GH-31462)
(cherry picked from commit ad3ca17ff5)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-04-20 09:48:04 -07:00
Miss Islington (bot)
33c6feb811
bpo-30718: Add information about text buffering (GH-32351)
(cherry picked from commit 5101d97d0b)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-04-20 02:00:32 -07:00