summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* [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>
* Add link to sys.path in os lib (GH-91679)Miss Islington (bot)2022-04-201-2/+2
| | | | | (cherry picked from commit 692aea6f3823df48b7fc267ba0aa1ccc45ac606d) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* Fix awkward sentence in signal docs (GH-91508)Miss Islington (bot)2022-04-201-4/+5
| | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 326ae71f1d93c12100150baa1173ea7ce7a96ea0) Co-authored-by: AJ Jordan <alex@strugee.net>
* [3.9] gh-91118: Fix docstrings that do not honor --without-doc-strings ↵Oleg Iarygin2022-04-197-11/+11
| | | | | | | | (GH-31769) (#91664) Co-authored-by: Éric <merwok@netwok.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit a573cb2fec664c645ab744658d7e941d72e1a398)
* Doc: Fix link formatting typo (GH-91659)Miss Islington (bot)2022-04-191-1/+1
| | | | | (cherry picked from commit 6a7a8a740e61508cb5a0fcdac8b752b6c9e5d1ea) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* Remove duplicate explanation (GH-91534)Miss Islington (bot)2022-04-181-4/+0
| | | | | (cherry picked from commit 0e6dca01937b62c07cff5b8450b7c74c101b857d) Co-authored-by: Gouvernathor <44340603+Gouvernathor@users.noreply.github.com>
* gh-89885: Improve import example in language reference (GH-91523) (#91649)Miss Islington (bot)2022-04-171-6/+4
| | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit d5a69571f586080af4c29671c47f9c4bc671af7f) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* gh-91541: Fix error in example in modules tutorial (GH-91634)Miss Islington (bot)2022-04-171-1/+1
| | | | | (cherry picked from commit efbc668183400597070356a2df2fbab114a53cb3) Co-authored-by: 180909 <734461790@qq.com>
* gh-90923: Improve sqlite3.Connection.execute* docs (GH-91643)Miss Islington (bot)2022-04-171-12/+9
| | | | | | | | - Drop 'nonstandard'; it does not add any value - Try to be more concise - Make return value a little more explicit (cherry picked from commit 017f07a229a337e9c17bed8cd1879e0177a8d89d) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
* gh-82849: revise intro to os.path.rst (GH-32232)Miss Islington (bot)2022-04-161-11/+4
| | | | | | | | | | * revise the first paragraph of docs for os.path * add a mention of `os.PathLike` protocol * remove warnings rendered irrelevant by :pep:`383` and :pep:`529` Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 468314cc8bfdb6fd328cbbbb7d0807728f25e043) Co-authored-by: Jack DeVries <jdevries3133@gmail.com>
* Add link to documentation translation list (GH-91560) (#91588)Miss Islington (bot)2022-04-161-0/+4
| | | | | | | (cherry picked from commit c4e8a93eb3fa5e5d930cea64f213443242c2588c) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com> Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* bpo-40376: slightly improved the wording for os.getgrouplist (GH-19702) ↵Miss Islington (bot)2022-04-151-1/+2
| | | | | | | | | | | (GH-91557) The documentation for os.getgrouplist potentially read like it returned all groups a user belongs to but it potentially doesn't. Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit bd26ef5e9e701d2ab3509a49d9351259a3670772) Co-authored-by: Jens Holzkämper <jens@holzkaemper.berlin>
* gh-70979: Fix runpy.run_path parameter name in docs (GH-32265)Miss Islington (bot)2022-04-151-2/+2
| | | | | | Noticed while reviewing GH-30729. (cherry picked from commit f1e989b04507db6f0adbccb5e1624d81cb217ea8) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* Add redirects to Misc/NEWS bpo links (GH-91454) (GH-91536)Miss Islington (bot)2022-04-141-1/+2
| | | | | (cherry picked from commit 17dbb6bc10ca8a8b602335414c047294f00afcbe) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* gh-90879: Fix missing parameter for put_nowait() (GH-91514)Miss Islington (bot)2022-04-141-2/+2
| | | | | (cherry picked from commit 0fc3517cf46ec79b4681c31916d4081055a7ed09) Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
* gh-87497: Document that urllib.request sends headers in camel case (GH-24661)Miss Islington (bot)2022-04-141-0/+1
| | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 325d6f50357474c7d9fd2475be0e2481f7ae0476) Co-authored-by: Alix Lourme <alix.lourme@gmail.com>