summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* [3.10] gh-91888: add a :gh: role to the documentation (GH-91889) (#91934)Ezio Melotti2022-04-261-0/+24
| | | | | | | | | | | | | | | | | | * gh-91888: Add a :gh: role to the documentation (GH-91889). * [3.10] 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.10] Update Sphinx bpo role to use redirect URI. (#91890)Ezio Melotti2022-04-241-1/+1
| | | | | | | | | | * Update Sphinx bpo role to use redirect URI. (GH-32342) * [3.10] Update Sphinx bpo role to use redirect URI. (GH-32342). (cherry picked from commit 08cfe079503ffd19d8b7ab324f0fdb1c6b150ca8) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> * Fix whitespace.
* gh-85864: Mark positional-only args in io docs (GH-91683)Miss Islington (bot)2022-04-231-10/+10
| | | | | (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>
* gh-87497: Document that urllib.request sends headers in camel case ↵Miss Islington (bot)2022-04-201-0/+1
| | | | | | | | (GH-24661) (#91517) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 325d6f50357474c7d9fd2475be0e2481f7ae0476) Co-authored-by: Alix Lourme <alix.lourme@gmail.com>
* [3.10] gh-91118: Fix docstrings that do not honor --without-doc-strings ↵Oleg Iarygin2022-04-197-11/+11
| | | | | | | | | (GH-31769) (#91662) Co-authored-by: Éric <merwok@netwok.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit a573cb2fec664c645ab744658d7e941d72e1a398) Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
* 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)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) (#91589)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>
* gh-88513: clarify shutil.copytree's dirs_exist_ok arg (GH-91434) (GH-91464)Miss Islington (bot)2022-04-151-6/+11
| | | | | | | * add a paragraph to document this kwarg in detail * update docstring in the source accordingly (cherry picked from commit f33e2c87a83917b5139d97fd8ef7cba7223ebef5) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* 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-91535)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>
* pickle docs: Fix typos and improve wording (GH-24776) (GH-32395)Miss Islington (bot)2022-04-081-24/+23
| | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 1d0f08fa46b54f5a9b43a916b66d50b97d56cf36) Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
* ssl docs: Fix typo (GH-32336)Miss Islington (bot)2022-04-071-1/+1
| | | | | (cherry picked from commit 9ee2d3a93914776d15ac5cc7c44bb3aaca3e0fe5) Co-authored-by: Frederick <fmoor@users.noreply.github.com>
* c-api docs: There are five fields, not four (GH-32379)Miss Islington (bot)2022-04-071-1/+1
| | | | | (cherry picked from commit 4c92427fb85e420404a9bd26347e32acc1bbd3b7) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* doc: Link to `string.capwords` from `str.title` (GH-20913)Miss Islington (bot)2022-04-071-1/+5
| | | | | | | | Since `title()` mentions its own short-comings, it should also mention the library function which does not possess them. Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit b786d9ec52a2c2b0b6627be7fd4a3948c61fbdea) Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
* ssl docs: Fix typo (GH-32314)Miss Islington (bot)2022-04-071-1/+1
| | | | | (cherry picked from commit 1da9c38fd352465fd3d1a00e64dc90444b421730) Co-authored-by: Frederick <fmoor@users.noreply.github.com>
* pkgutil docs: Link sys constants, add backticks (GH-32356)Miss Islington (bot)2022-04-071-4/+4
| | | | | | Co-authored-by: Éric <merwok@netwok.org> (cherry picked from commit 63bd72448a5af01206c2a9aec5f1ed1e903f1e12) Co-authored-by: Boris Verkhovskiy <boris.verk@gmail.com>
* stdtypes docs: fix typo (GH-32349) (GH-32370)Miss Islington (bot)2022-04-071-1/+1
| | | | | (cherry picked from commit b33c4564aceeae8323bcb19167fbbd2d5f5002bc) Co-authored-by: Ian <40774387+isteptoe@users.noreply.github.com>
* [3.10] bpo-46769: Fix backticks in typing.rst to appease rstlint (GH-32374)Ken Jin2022-04-062-2/+2
| | | | | * Use double backticks to appease rstlint * Update susp-ignored.csv
* bpo-47235: Note where a typo is intentional in code. (GH-32348)Miss Islington (bot)2022-04-061-4/+4
| | | | | | | | | | | | | | People keep popping up reporting these as typos in the docs despite being described as typos in the surrounding text. Hopefully a comment on the line itself makes it more obvious? Arguably some of the typo examples are not using the "right" typo as the "assret" one in particular is now detected by default due to how common it was in actual code. But I don't want to to typo chasing by changing these examples to be other not yet auto-detected typos as they still illustrate the point well enough. (cherry picked from commit ac1fb07b6ecb6b93446484f52894914e5199de63) Co-authored-by: Gregory P. Smith <greg@krypto.org>
* bpo-40982: shutil docs: Remove outdated copytree() example (GH-24778)Miss Islington (bot)2022-04-051-36/+1
| | | | | | | It is not preferable to keep a copy of the implementation in the docs. (cherry picked from commit e06f920c5bc6e9fad29082ba0d84043722806e17) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* crypt docs: Fix references to `methods` attr (GH-26806)Miss Islington (bot)2022-04-051-4/+3
| | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit cae0f5d3dad6db0d13690e5952ae2015ad8b3a05) Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
* bpo-32658: Regex docs: Fix metacharacter reference (GH-32230)Miss Islington (bot)2022-04-051-1/+1
| | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 43571a3eea8b5931769376daf4bdad1c9184ae0d) Co-authored-by: Mike cm <mikecmcleod@gmail.com>
* bpo-45790: List macros in same order in which fields are described (GH-29529)Miss Islington (bot)2022-04-051-2/+2
| | | | | | | | Signed-off-by: Rodrigo Tobar <rtobar@icrar.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit b275267aa7d44ec90fa435c9cb1610c549da745a) Co-authored-by: rtobar <rtobar@icrar.org>
* bpo-47007: [doc] `str` special method lookup (GH-31863)Miss Islington (bot)2022-04-051-1/+2
| | | | | | | | | Clarify the `str()` docs to point out that `object.__str__()` follows special method lookup. Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit bb86d1d9fbd1888524e04475383f4ea764277f67) Co-authored-by: Vanshaj Singhania <8797467+itsvs@users.noreply.github.com>
* bpo-41233: Add links to errnos referenced in exceptions docs (GH-21380)Miss Islington (bot)2022-04-052-37/+52
| | | | | | | Co-authored-by: Andrew Kuchling <amk@amk.ca> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit a74892cb2168d249d9a8c53fad605a5def9b41d4) Co-authored-by: yyyyyyyan <24644216+yyyyyyyan@users.noreply.github.com>
* Demonstrate `py --list` in the quickstart section of the Windows doc page ↵Miss Islington (bot)2022-04-041-0/+6
| | | | | | | (GH-29383) (cherry picked from commit 1ecfe3d5ae4ddec4e73a6cfc93fed6df43fe0be5) Co-authored-by: Christian Clauss <cclauss@me.com>
* Follow PEP-8 guidelines in tutorial for standard library (GH-26127)Miss Islington (bot)2022-04-031-2/+3
| | | | | (cherry picked from commit 6db2db91b96aaa1270c200ec931a2250fe2799c7) Co-authored-by: Bob Kline <bkline@users.noreply.github.com>
* Language reference: Remove duplicated text about iterable unpacking (GH-25212)Miss Islington (bot)2022-04-031-3/+1
| | | | | (cherry picked from commit 4f5d56f8f33196f5ed8ffad0ab2f012afda2f9b3) Co-authored-by: Jiashuo Li <4003950+jiasli@users.noreply.github.com>
* bpo-24563: Link encoding names to encoding declarations (GH-32274)Miss Islington (bot)2022-04-031-3/+2
| | | | | (cherry picked from commit 01be5d6446abbdd95d0c18bd19a58a62b05568d8) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* [3.10] More minor fixes to C API docs (GH-31525) (GH-32258)Jelle Zijlstra2022-04-0213-28/+29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * wording fixes in type.rst * grammar and punctuation in sys.rst * set: grammar fixes * structures: capitalization fix * grammar fixes for sequence * objects: point to Py_TYPE instead of direct object access * numbers: add more explicit Python equivalences * method: add missing period * memory: grammar fix * mapping: grammar fixes * long: grammar fix * iter: fix grammar for PyAIter_Check * init: grammar fix. (cherry picked from commit 897bc6f9282238d5fb32d232ab62d30675244736) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* [3.10] Document func parameter of locale.atof (GH-18183) (GH-32262)Jelle Zijlstra2022-04-021-3/+3
| | | | | | | | | | | | The second parameter (named `func`) has been present since the `locale` module was introduced in eef1d4e8b1, but has never been documented. This commit updates the documentation for `locale.atof` to clarify the behavior of the function and how the `func` parameter is used. Signed-off-by: Kevin Locke <kevin@kevinlocke.name> (cherry picked from commit 208da6d508bb2683732151f4ae288dfc8001267c) Co-authored-by: Kevin Locke <kevin@kevinlocke.name>
* bpo-45584: Clarify `math.trunc` documentation (GH-29183)Miss Islington (bot)2022-04-021-8/+10
| | | | | | | | | | | While floor/ceil 's documentation are very precise, `truncate` was not explained. I actually had to search online to understand the difference between `truncate` and `floor` (admittedly, once I remembered that numbers are signed, and that floating numbers actually uses a bit for negation symbol instead of two complement, it became obvious) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Éric Araujo <merwok@netwok.org> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit ebbdbbff5d6840807e46ec61b8a323e94ee88de2) Co-authored-by: Arthur Milchior <arthur@milchior.fr>
* os docs: fix typo (GH-28996)Miss Islington (bot)2022-04-021-1/+1
| | | | | | Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com> (cherry picked from commit 1f80dcd2442f2a354097797fedc077592984903b) Co-authored-by: Vitor Buxbaum Orlandi <vitorbuxbaum@gmail.com>
* codecs docs: fix grammar mistake (GH-29462)Miss Islington (bot)2022-04-021-1/+1
| | | | | (cherry picked from commit ea56845744e815ed468dfbdd835110254c3be997) Co-authored-by: 180909 <wjh180909@gmail.com>
* bpo-45114: Use lstat() instead of stat() in stat docs example (GH-29845)Miss Islington (bot)2022-04-021-1/+1
| | | | | (cherry picked from commit c93a0ac6972221787d8bea1c41a9feb667ed3d2c) Co-authored-by: 180909 <wjh180909@gmail.com>
* bpo-47031: Improve documentation for `math.nan` (GH-32170)Miss Islington (bot)2022-04-021-2/+17
| | | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 182e93c3f57b0c72e765c9896066d32e461c0865) Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
* More minor fixes to C API docs (GH-31714)Miss Islington (bot)2022-04-025-11/+9
| | | | | | | | | | * init_config: wording fixes * bytearray: remove XXX, there is a good link to the buffer docs * bytes, call, exceptions: minor wording fixes (cherry picked from commit 677a87946630c5fbd9998969669b4dd4f4b32545) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* bpo-14911: Corrected generator.throw() documentation (GH-32207)Miss Islington (bot)2022-03-313-4/+18
| | | | | | Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com> (cherry picked from commit 8be7c2bc5ad5e295f0f855bb31db412eef2c7c92) Co-authored-by: Dave Goncalves <davegoncalves@gmail.com>
* bpo-42340: Document issues around KeyboardInterrupt (GH-23255)Miss Islington (bot)2022-03-292-0/+79
| | | | | | | | Update documentation to note that in some circumstances, KeyboardInterrupt may cause code to enter an inconsistent state. Also document sample workaround to avoid KeyboardInterrupt, if needed. (cherry picked from commit d0906c90fcfbc4cfb9bb963eaa6bb152dd543b56) Co-authored-by: benfogle <benfogle@gmail.com>
generated by cgit v0.12 at 2025-03-04 07:05:14 (GMT)