summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* Document Py_ssize_t. (GH-92512)Miss Islington (bot)2022-05-1310-24/+31
| | | | | | | | | 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 664aa94b570a4a8f3535efb2e3d638a4ab655943) Co-authored-by: Julien Palard <julien@palard.fr>
* Fix typo in argparse docs. (GH-92691) (#92731)thueringa2022-05-131-1/+1
|
* [3.9] gh-92436: __future__ docs: add note on expectations for "from ↵Jelle Zijlstra2022-05-121-1/+9
| | | | | | | __future__ import annotations" (GH-92568). (#92726) (cherry picked from commit 6582c96454ddb731eb412c2a473300172225fdb9) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* [3.9] Fix typo in unittest.rst: addCleanupModule -> addModuleCleanup ↵Miss Islington (bot)2022-05-111-1/+1
| | | | | | | | | | (GH-92631) (GH-92661) (cherry picked from commit 38486ca212c0827d54e7b0d0b1e2c1ccc2bdad33) Co-authored-by: Mikhail Terekhov <termim@gmail.com> Automerge-Triggered-By: GH:serhiy-storchaka
* [3.9] gh-76773: Update docs mentioning no-longer-supported Windows versions ↵Miss Islington (bot)2022-05-107-101/+58
| | | | | | | | | | & features (GH-92529) (GH-92610) (cherry picked from commit f1bbcba74f77eff2a4c0881f3d529f3bf0664d40) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM> Automerge-Triggered-By: GH:serhiy-storchaka
* bpo-13553: Document tkinter.Tk args (GH-4786)Miss Islington (bot)2022-05-101-10/+66
| | | | | (cherry picked from commit c56e2bb9949c95ec8911cd5554b07044a564796f) Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
* Doc: Update py2app link. (GH-91585)Miss Islington (bot)2022-05-091-1/+1
| | | | | | See: https://mail.python.org/archives/list/docs@python.org/thread/KDVFGNGGUGGPVRZT7WZYHHWXCRS2GEN7/ (cherry picked from commit b77a95f44a024d1afab28e380252aa6d9c4efb1c) Co-authored-by: Julien Palard <julien@palard.fr>
* gh-92417: `asyncio` docs: `asyncio.run()` is available on all supported ↵Miss Islington (bot)2022-05-091-1/+0
| | | | | | | Python versions (GH-92419) (cherry picked from commit f4e317b304c7f86e48885b4b74c7a8826648922c) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* bpo-38056: overhaul Error Handlers section in codecs documentation (GH-15732)Miss Islington (bot)2022-05-092-74/+126
| | | | | | | | | | | | | * 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 5bc2390229bbcb4f13359e867fd8a140a1d5496b) Co-authored-by: Ma Lin <animalize@users.noreply.github.com>
* pdb docs: workaround for double semicolon in strings (GH-17011)Miss Islington (bot)2022-05-081-1/+2
| | | | | | | | see https://github.com/gotcha/ipdb/issues/172 Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 2888b1107fd0b43cc800987a00155bdbeacdb23a) Co-authored-by: Godefroid Chapelle <gotcha@bubblenet.be>
* gh-77521: Add link to builtin module names in modules tutorial (GH-92438)Miss Islington (bot)2022-05-081-1/+2
| | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 859250cc55711f4d62b65922d3f7537826c3801e) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* gh-92417: `logging` docs: Remove warning that only applies to Python <3.2 ↵Miss Islington (bot)2022-05-081-10/+0
| | | | | | | (GH-92425) (cherry picked from commit 318c4e91ef166bcd5d513bb42b9156d54d423d4a) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.9] gh-92417: `json` docs: `dict` is ordered on all supported Python ↵Miss Islington (bot)2022-05-081-7/+0
| | | | | | | | | | versions (GH-92422) (GH-92466) (cherry picked from commit bc098cfdb756f207d8fa84793e8ad91a2f263efb) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Automerge-Triggered-By: GH:serhiy-storchaka
* [3.9] GH-92431: Fix footnotes in Doc/c-api/exceptions.rst (GH-92432) (GH-92471)Miss Islington (bot)2022-05-081-11/+11
| | | | | | | | | | | * 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 788ef54bc94b0a7aa2a93f626e4067ab8561424c) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Automerge-Triggered-By: GH:serhiy-storchaka
* [3.9] gh-77630: Change Charset to charset (GH-92439) (GH-92477)Miss Islington (bot)2022-05-081-7/+7
| | | | | | | | (cherry picked from commit 8f293180791f2836570bdfc29aadba04a538d435) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com> Automerge-Triggered-By: GH:serhiy-storchaka
* [3.9] gh-92417: `stdtypes` docs: delete discussion of Python 2 differences ↵Miss Islington (bot)2022-05-081-10/+0
| | | | | | | | | | | | | (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 8efda1e7c6343b1671d93837bf2c146e4cf77bbf) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Automerge-Triggered-By: GH:serhiy-storchaka
* gh-92417: `typing` docs: `from __future__ import annotations` can be used in ↵Miss Islington (bot)2022-05-081-1/+1
| | | | | | | all supported Python versions (GH-92418) (cherry picked from commit e5b4bd4d60aaf0292c5b9d628512145b8987b3c6) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.9] gh-92448: Update the documentation builder to render the GitHub issue. ↵Dong-hee Na2022-05-081-4/+5
| | | | (GH-92449). (GH-92458)
* gh-92368: Fix missing possessive apostrophe (GH-92397)Miss Islington (bot)2022-05-061-1/+1
| | | | | | * Fix missing possessive apostrophe (cherry picked from commit a79001ee16b3ea8b5d0fad595c969d9e1b7627f3) Co-authored-by: gophra <105054704+gophra@users.noreply.github.com>
* gh-92047: Py_GetVersion multi-digit minor version (GH-92047) (GH-92048) (#92329)Miss Islington (bot)2022-05-061-1/+1
| | | | | | | (cherry picked from commit 43b135f94ebf3e6e84ddb0f75ed8510b96a610e4) Co-authored-by: Robert Howlett <robert@howletts.org.uk> Co-authored-by: Robert Howlett <robert@howletts.org.uk>
* Document the lifetime of `PyUnicode_AsUTF8String` (GH-92325)Miss Islington (bot)2022-05-061-1/+2
| | | | | | The current wording implied this, but didn't state it explicitly. (cherry picked from commit 740da8d37a84638f4a8893bee3648f36fc6beb0f) Co-authored-by: Matt Wozniski <godlygeek@gmail.com>
* gh-92223: Remove pre-Python 3.7 alternative in asyncio docs (GH-92224)Miss Islington (bot)2022-05-051-16/+1
| | | | | (cherry picked from commit d1b2e989be2bc5128d6602e4f370d0ee6f5ac476) Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
* [3.9] Improve the typing docs (GH-92264) (#92271)Jelle Zijlstra2022-05-031-12/+12
| | | | | | Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>. (cherry picked from commit 27e366571590e9e98f61dccf69dbeaa88ee66737) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* gh-87304: Improve comments in language reference for imports (GH-92164)Miss Islington (bot)2022-05-031-3/+3
| | | | | (cherry picked from commit ee2205b208389611e8a278ac1bc74b34f4994fd2) Co-authored-by: Robert Yang <35813883+robert861212@users.noreply.github.com>
* [3.9] bpo-46586: Fix more erroneous doc links to builtins (GH-31429) (#92199)Jelle Zijlstra2022-05-032-2/+2
| | | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Éric <merwok@netwok.org>. (cherry picked from commit cc6ae4f4835f9e76a34f24cd1f666c1cc0fecfa3) Co-authored-by: Meer Suri <46469858+meersuri@users.noreply.github.com>
* bpo-6686: Replace String with Bytes in xml.sax.handler documentation (GH-30612)Miss Islington (bot)2022-05-021-1/+1
| | | | | (cherry picked from commit 32e4f450af3fbcc5c7e186f83ff74e2efe164136) Co-authored-by: Yassir Karroum <ukarroum17@gmail.com>
* [3.9] Remove effbot urls (GH-26308). (#92162)Thaddeus14992022-05-025-24/+3
| | | | | (cherry picked from commit e9f66aedf44ccc3be27975cfb070a44ce6a6bd13) Co-authored-by: E-Paine <63801254+E-Paine@users.noreply.github.com>
* gh-91783: Document security considerations for shutil.unpack_archive (GH-91844)Miss Islington (bot)2022-05-021-1/+7
| | | | | (cherry picked from commit 4b297a9ffd4a1d420c1a8016f4ed2c7f1d298469) Co-authored-by: Sam Ezeh <sam.z.ezeh@gmail.com>
* gh-88546: glob.glob docs: Make new paragraph for emphasis and reordered ↵Miss Islington (bot)2022-05-021-2/+5
| | | | | | | sentence (GH-91614) (cherry picked from commit b9ab6cea0819bd498063f0934cb5bb0bb5a6a2d4) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* asyncio.subprocess: Fix a typo in doc (GH-92030)Miss Islington (bot)2022-05-021-1/+1
| | | | | | Remove a confusion for read method in asyncio-subprocess doc for stderr StreamReader instance (cherry picked from commit bb857a96ef368ba9de1da2db12b1a1f1870606ac) Co-authored-by: Harsh <65716674+Harsh-br0@users.noreply.github.com>
* Fix typo in Programming FAQ (GH-92083)Miss Islington (bot)2022-05-021-1/+1
| | | | | | I believe the word "with" was missing here. (cherry picked from commit 2a7efa324274a54fe0e5480cae1438d8294b9ec3) Co-authored-by: Matt Harding <majaharding@gmail.com>
* gh-85133: os docs: Add that getenv uses os.environ (GH-91874)Miss Islington (bot)2022-05-021-13/+21
| | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit b25352a5c039d95e019dd8ca111f6f77c43ca1f7) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* gh-84714: Add behavior if dst file exists (GH-91867)Miss Islington (bot)2022-05-021-1/+2
| | | | | (cherry picked from commit 9166ace805d915c8a918cd89fff0e58b65e3327c) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* [3.9] gh-81488: Add recursive wording for issubclass docs (GH-92087) (#92131)slateny2022-05-021-1/+2
| | | | | (cherry picked from commit 1066ecb97042b8e89de554e6f9dc2e3d634208c0) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* gh-85679: Recommend `encoding="utf-8"` in tutorial (GH-91778)Miss Islington (bot)2022-05-021-10/+18
| | | | | (cherry picked from commit 614420df9796c8a4f01e24052fc0128b4c20c5bf) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* typing docs: Add example for async functions (GH-20386)Miss Islington (bot)2022-05-011-0/+4
| | | | | | Fixes python/typingGH-424 (cherry picked from commit 9588f880a286a8cc5597188f6ab44108c8f18761) Co-authored-by: Sam Bull <aa6bs0@sambull.org>
* gh-91611: Use example.com for documentation, not mydomain.com (GH-91613)Miss Islington (bot)2022-05-012-2/+2
| | | | | | | | | | 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 ea392467829d6e93f824bde8eb87bdb31d9e4c62) Co-authored-by: Motoki Naruse <motoki@naru.se>
* gh-87801: Add run() to subprocess.CalledProcessError description (GH-91628)Miss Islington (bot)2022-04-301-1/+3
| | | | | (cherry picked from commit 567be058b403db9689af45bf831d4c732c8b1105) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* gh-87192: Update wording for fcntl 'Changed in' (GH-91658)Miss Islington (bot)2022-04-301-1/+2
| | | | | (cherry picked from commit d7eb1ffbe8f913693e4c9ffa1b32edccac987ab6) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* gh-85864: io docs: Add missing position-only parameters (GH-91950)Miss Islington (bot)2022-04-301-17/+17
| | | | | (cherry picked from commit 3a8e2b6e65fea1252477f6e29a384fa9a492ed06) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* sorting howto: Add clarification on < using __lt__ (GH-92010)Miss Islington (bot)2022-04-291-1/+4
| | | | | (cherry picked from commit 53ca774497fde7c5fcf3a84813ea42f95f75c639) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* Add note that headers added via urllib.request.add_header are added to ↵Miss Islington (bot)2022-04-271-1/+2
| | | | | | | | | redirected requests (GH-30708) (#92005) (cherry picked from commit f348154c8f8a9c254503306c59d6779d4d09b3a9) Co-authored-by: Ashwin Ramaswami <aramaswamis@gmail.com> Co-authored-by: Ashwin Ramaswami <aramaswamis@gmail.com>
* gh-84459: Make wording more specific for Path.replace (GH-91853)Miss Islington (bot)2022-04-272-2/+2
| | | | | | GH-84459 (cherry picked from commit 161dff7e10eeb7eaf6d418b91e993aaf84770a5c) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* gh-68966: Document mailcap deprecation in Python 3.11 (GH-91971)Miss Islington (bot)2022-04-273-2/+7
| | | | | | (cherry picked from commit 80de0273c0caf8bae19787bb00255eb3fb2a2d0c) (cherry picked from commit a36d97e3f1daeb431e1c5bc8ab83daca93b747b0) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.9] gh-91888: add a `:gh:` role to the documentation (GH-91889) (#91935)Ezio Melotti2022-04-261-0/+24
| | | | | | | | | | | | | | | | | | * 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 f7641a2ffec243e5f600028a84debe9028a9ee44) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* [3.9] Update Sphinx bpo role to use redirect URI. (#91891)Ezio Melotti2022-04-241-1/+1
| | | | | | | | * 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 08cfe079503ffd19d8b7ab324f0fdb1c6b150ca8) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* [3.9] gh-85864: Mark positional-only args in io docs (GH-91683). (#91848)Jelle Zijlstra2022-04-231-9/+9
| | | | | (cherry picked from commit a3f2cf3ced378db2569df4e7389ec1f79c85d55c) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* gh-91547: Remove "Undocumented modules" page (GH-91682)Miss Islington (bot)2022-04-222-27/+0
| | | | | (cherry picked from commit 254aaa7981d8773658fb14795da5dec888c95f93) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* bpo-23747: Enhance platform doc, document default behavior (GH-31462)Miss Islington (bot)2022-04-201-6/+8
| | | | | (cherry picked from commit ad3ca17ff5cd63f907430073b52be27695674148) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* bpo-30718: Add information about text buffering (GH-32351)Miss Islington (bot)2022-04-201-1/+5
| | | | | (cherry picked from commit 5101d97d0b13425ccc5ed37abfabb07701db81fe) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>