summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* bpo-45916: Use HTTPS link for The Perils of Floating Point (GH-29896)Miss Islington (bot)2021-12-021-1/+1
| | | | | (cherry picked from commit 9f2f7e42269db74a89fc8cd74d82a875787f01d7) Co-authored-by: Zachary Ware <zach@python.org>
* docs: Improve example for urlparse() (GH-29816) (GH-29888)Miss Islington (bot)2021-12-021-31/+42
| | | | | | (cherry picked from commit 226d22ff2d209495621550eb78e81ed4c0fe0152) Co-authored-by: Christian Clauss <cclauss@me.com>
* bpo-45896: Fix docs default asyncio event loop on Windows (GH-29857) (GH-29877)Miss Islington (bot)2021-12-011-3/+4
| | | | | (cherry picked from commit f27bef30438d2f07f19de91e021f34b77ccc4b20) Co-authored-by: Rob <r4226@pm.me>
* bpo-33381: [doc] strftime's %f option may pad zeros on the left or the right ↵Miss Islington (bot)2021-11-301-2/+2
| | | | | | | | (GH-29801) (GH-29862) (cherry picked from commit f97ec09baf8431494fd2ef5133090c7b0afd0551) Co-authored-by: Vishal Pandey <vishalpandeyviptsk@gmail.com>
* bpo-43905: Expand dataclasses.astuple() and asdict() docs (GH-26154)Miss Islington (bot)2021-11-291-4/+18
| | | | | | | | | Expanded ``astuple()`` docs, warning about deepcopy being applied and providing a workaround. Automerge-Triggered-By: GH:ericvsmith (cherry picked from commit c1f93f0d378958dfae4f24aad0c0088e3e04e403) Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
* [3.10] [Doc] Add info to logging cookbook about running logging socket ↵Miss Islington (bot)2021-11-291-0/+22
| | | | listeners i… (GH-29838) (GH-29839)
* bpo-45619: documentation of execution model: clarify and update binding ↵Miss Islington (bot)2021-11-261-9/+19
| | | | | | | | | | | | | summary (GH-29232) This does two changes that are quite related. 0. it add that variable binding can occur in pattern matching, an update of 3.10 which seems to have been omitted from the list of bindings 1. Given how long the sentence already was, with even subcases in the middle of the sentence, the commit breaks the sentence into an actual list. (cherry picked from commit cd876c84932ecc2f7a6c41f3fc800a34d5b06b95) Co-authored-by: Arthur Milchior <arthur@milchior.fr>
* [3.10] bpo-45568: Actually use @asynccontextmanager in usage example ↵Andrew Svetlov2021-11-251-0/+2
| | | | | | | | | | (GH-29151) (GH-29779) Automerge-Triggered-By: GH:asvetlov (cherry picked from commit 4dd82194f4a0e48a94191655e571b3aad1c4a22a) Co-authored-by: Zbigniew Siciarz <zbigniew@siciarz.net> Co-authored-by: Zbigniew Siciarz <zbigniew@siciarz.net>
* bpo-45693: Document `port` parameter to `loop.create_server` (GH-29760) ↵Miss Islington (bot)2021-11-241-0/+5
| | | | | | | | | | | | | | | (GH-29762) Document the `port` parameter to `loop.create_server` in `asyncio`. In particular, note that if `host` resolves to multiple network interfaces, passing in `port=0` will result in a different random unused port being used for each interface. Automerge-Triggered-By: GH:ericvsmith (cherry picked from commit d71c7bc7339eb82de493c66ebbbfa1cad250ac78) Co-authored-by: Jim Crist-Harif <jcristharif@gmail.com> Co-authored-by: Jim Crist-Harif <jcristharif@gmail.com>
* [3.10] bpo-45250: fix docs regarding `__iter__` and iterators being ↵Brett Cannon2021-11-226-47/+49
| | | | | | | | inconsistently required by CPython (GH-29170) (GH-29650) It is now considered a historical accident that e.g. `for` loops and the `iter()` built-in function do not require the iterators they work with to define `__iter__`, only `__next__`. (cherry picked from commit be36e0634060c7d5dee8e8876fb888bbb53d992a) Co-authored-by: Brett Cannon <brett@python.org>
* [3.10] bpo-45845: Change link for pyserial (GH-29675)Miss Islington (bot)2021-11-201-2/+2
| | | | | | (cherry picked from commit 123a3527ddd7774e8db325c778927e49172e01d4) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* bpo-45845: Remove unresponsive web link (GH-29651) (GH-29674)Miss Islington (bot)2021-11-201-3/+0
| | | | | | | Threading notes by Aahz from OSCON 2001. (cherry picked from commit 985233914504c73f14a23af1c68a3709079e6913) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* bpo-45846: Fix capitalisation of Van Rossum at the start of sentence ↵Miss Islington (bot)2021-11-201-1/+1
| | | | | | | (GH-29641) (GH-29656) (cherry picked from commit bc2bc0dbdb52498d009f9f9771452e6aa4faff2b) Co-authored-by: JMcB <joel.mcbride1@live.com>
* bpo-19072: Classmethod can wrap other classmethod like descriptors ↵Miss Islington (bot)2021-11-191-1/+8
| | | | | | | | | | (GH-29634) (GH-29643) staticmethod() also became callable in Python 3.10. See: b83861f02. (cherry picked from commit e34809e1c2a09478f4e0651d551c9c12d3c556ab) Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
* [3.10] bpo-45788: Link sys.prefix doc to 'Installation paths' (GH-29606)Miss Islington (bot)2021-11-182-7/+6
| | | | | | | ... To the Installation paths section of the sysconfig doc. (cherry picked from commit 4575c01b750cd26377e803247c38d65dad15e26a) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* [3.10] [doc] bpo-45680: Disambiguate ``__getitem__`` and ↵Miss Islington (bot)2021-11-183-18/+148
| | | | | | | | | | | | | | | | | ``__class_getitem__`` in the data model (GH-29389) (GH-29620) The documentation explaining Python's data model does not adequately explain the differences between ``__getitem__`` and ``__class_getitem__``, nor does it explain when each is called. There is an attempt at explaining ``__class_getitem__`` in the documentation for ``GenericAlias`` objects, but this does not give sufficient clarity into how the method works. Moreover, it is the wrong place for that information to be found; the explanation of ``__class_getitem__`` should be in the documentation explaining the data model. This PR has been split off from GH-29335. (cherry picked from commit 31b3a70edb1216bdc8fab3b2eafd8ddb00487f41) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* bpo-45640: [docs] Tokens are now clickable (GH-29260) (GH-29621)Miss Islington (bot)2021-11-183-53/+53
| | | | | | Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit 32959108f9c543e3cb9f2b68bbc782bddded6f42) Co-authored-by: Arthur Milchior <arthur@milchior.fr>
* [doc] Expand on soft keywords in the docs for keyword.py (GH-29139) (GH-29195)Miss Islington (bot)2021-11-181-3/+3
| | | | | | | Add link at the top and fix the existing links to point to the "[soft keywords](https://docs.python.org/3.10/reference/lexical_analysis.htmlGH-soft-keywords)" section created in the Python 3.10 docs. (cherry picked from commit 9e05da62241877a871c7b22ef723d7028ce03c90) Co-authored-by: William Andrea <william.j.andrea@gmail.com>
* bpo-45701: Improve documentation for *typed* parameter (GH-29498) (GH-29509)Miss Islington (bot)2021-11-181-4/+10
| | | | | (cherry picked from commit 912a4ccc3a523e2990cc501393adfc661614c73a) Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
* [3.10] [Enum] update member.member removal (GH-29608)Ethan Furman2021-11-181-1/+1
| | | Accessing one enum member from another originally raised an `AttributeError`, but became possible due to a performance boost implementation detail. In 3.11 it will again raise an `AttributeError`.
* [docs] Add missing word "any" in unittest -k cmdline option description ↵Miss Islington (bot)2021-11-181-1/+1
| | | | | | | (GH-29571) (GH-29603) (cherry picked from commit abc0d754c3853c6e69ec3718505871e7e42ec93d) Co-authored-by: ch33zer <ch33zer@gmail.com>
* Save a reference for ensure_future and create_task (GH-29163)Miss Islington (bot)2021-11-162-0/+8
| | | | | | Co-authored-by: Joannah Nanjekye <jnanjekye@python.org> (cherry picked from commit c750adbe6990ee8239b27d5f4591283a06bfe862) Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
* bpo-45677: Reword first section of `sqlite3` docs (GH-29326) (GH-29566)Miss Islington (bot)2021-11-151-18/+20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * bpo-45677: Avoid addressing the reader as 'you' in sqlite3 docs * Adjust wording * Adjust wording again * Typo * Update Doc/library/sqlite3.rst Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com> * Address review: adjust wording * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Lib/sqlite3/__init__.py Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Lib/sqlite3/__init__.py Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Apply Alex' suggestion, and apply 80 char limit to PR * Minor adjustment Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> (cherry picked from commit 6c5a312fb6d92e879bf4c570b94e18bb9ffe5970) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no> Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
* bpo-25381: Update explanation of exceptions in C. (GH-26838) (GH-29568)Miss Islington (bot)2021-11-151-7/+5
| | | | | | | Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> (cherry picked from commit ad43dc0b54994e7e7d06e3d4896ade188b36ee12)
* [3.10] bpo-45752: Fix no-support examples in 'copy' docs (GH-29548) (GH-29556)M. Mostafa Farzan2021-11-141-1/+1
| | | | | | | (cherry picked from commit b7360ae395e9e633d384d16064c5dc04a9841e19) Co-authored-by: M. Mostafa Farzan <m2_farzan@yahoo.com> Automerge-Triggered-By: GH:asvetlov
* bpo-45799: [Doc] improve confusing sentence in __main__.rst (GH-29546)Miss Islington (bot)2021-11-131-2/+2
| | | | | | | | I was reading this bit last night and thought it was a typo. In the light of day, I realized it wasn't *technically* a typo, but definitely confusing wording. This PR fixes the confusing sentence. Automerge-Triggered-By: GH:ericvsmith (cherry picked from commit f8da00ef04fdadf7cd9821e8ec4b317ecf3ed663) Co-authored-by: Jack DeVries <jdevries3133@gmail.com>
* [3.10] bpo-45772: socket.socket should be a class instead of a function ↵Miss Islington (bot)2021-11-131-1/+1
| | | | | | | | | | | | | | | | (GH-23960) (GH-29542) * [bpo-45772](): socket.socket should be a class instead of a function Currently `socket.socket` is documented as a function, but it is really a class (and thus has function-like usage to construct an object). This correction would ensure that Python projects that are interlinking Python's documentation can properly locate `socket.socket` as a type. (cherry picked from commit 4c792f39e688b11c7c19e411ed4f76a7baa44638) Co-authored-by: Hong Xu <hong@topbug.net> Automerge-Triggered-By: GH:asvetlov
* bpo-45792: Fix contextvar.Token's intersphinx FQN (GH-29533) (GH-29535)Miss Islington (bot)2021-11-121-1/+1
| | | | | | | | Since `.. module:: contextvars` sets the module using `.. class:: contextvars.Token`, intersphinx records it as `contextvars.contextvars.Token`. (cherry picked from commit e501d70b347c5093018d12482c30a7a98aab86d0) Co-authored-by: Hynek Schlawack <hs@ox.cx> Co-authored-by: Hynek Schlawack <hs@ox.cx>
* Closes bpo-45712: Add missing word in control flow tutorial (GH-29460)Miss Islington (bot)2021-11-081-1/+1
| | | | | (cherry picked from commit 7484a5c82a2dfc106bb1e4b060cad2df00521bfd) Co-authored-by: 180909 <734461790@qq.com>
* bpo-40170: Update What's New in Python 3.9 (GH-29470)Miss Islington (bot)2021-11-081-4/+0
| | | | | | | The PyType_HasFeature() change has been reverted: the static inline function access directly the PyTypeObject.tp_flags member. (cherry picked from commit 99c7e9853fa13af414168f179213e3d2fae03a45) Co-authored-by: Victor Stinner <vstinner@python.org>
* bpo-45741: docs: fix plural (GH-29461) (GH-29463)Miss Islington (bot)2021-11-081-1/+1
| | | | | | | | | | "entry points provides" -> "entry points provide" Automerge-Triggered-By: GH:ericvsmith (cherry picked from commit 19b107e9b52dbd73f4c52adcb91e8185a53b45ae) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com> Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
* bpo-39452: [doc] Change "must" to "can" on relative import style in ↵Miss Islington (bot)2021-11-061-1/+1
| | | | | | | `__main__` (GH-29379) (GH-29449) (cherry picked from commit 57457a1e5caf714034a75fe4f382b8b669ce6ed8) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* [doc] bpo-45680: Improve glossary entry for generic types (GH-29388) (GH-29447)Miss Islington (bot)2021-11-061-4/+5
| | | | | | Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit 77a2c77c84d2ead2d19f96df862c119308e90071) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* bpo-45762: Improve docs for ``@singledispatch``/``@singledispatchmethod`` ↵Miss Islington (bot)2021-11-051-22/+26
| | | | | | | (GH-29426) (GH-29431) (cherry picked from commit 71e8a3e76a32f5eabe20e7fa984f384ca9af6ec6) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* Remove reference to ``Tuple`` at top of ``typing`` docs (GH-29401)Miss Islington (bot)2021-11-041-4/+3
| | | | | | ``typing.Tuple`` has been deprecated since Python 3.9, so it makes no sense to mention it so prominently in the documentation for the ``typing`` module. (cherry picked from commit 87032cfa3dc975d7442fd57dea2c6a56d31c911a) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* bpo-45680: ``typing`` docs: improve links to docs on ↵Miss Islington (bot)2021-11-041-4/+4
| | | | | | | ``GenericAlias``/``__class_getitem__`` (GH-29387) (cherry picked from commit e03e50377d6f8f212af60fed4ae405ebeb73237d) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* bpo-45633: Fix newtypes doc typo (GH-29318) (GH-29364)Miss Islington (bot)2021-11-031-1/+1
| | | | | (cherry picked from commit 454cdb99abcda37413b15167cda564091fec2572) Co-authored-by: Dmitry Smirnov <dmitrysmirnov931@gmail.com>
* [doc] Link to section File input (GH-28941) (GH-29375)Miss Islington (bot)2021-11-021-1/+1
| | | | | (cherry picked from commit 48824fa1e26595ac97ffc96ee2c3d32ff130c420) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* bpo-45457: Minor fix to documentation for SSLContext.load_default_certs. ↵Miss Islington (bot)2021-11-021-1/+1
| | | | | | | | | | | (GH-28947) (GH-29373) Specify that SSLContext.set_default_verify_paths is called on ALL systems. The code of SSLContext.load_default_certs was changed in bpo-22449 to do this, this fix corrects the documentation to match that change. (cherry picked from commit 3551bf16ee5c25b6349209dd30e032f0f3b9ace3) Co-authored-by: LincolnPuzey <lincoln@puzey.dev>
* [3.10] Move field width to the right field (GH-29344) (GH-29351)Miss Islington (bot)2021-10-311-2/+2
| | | Co-authored-by: Olaf van der Spek <olafvdspek@gmail.com>
* bpo-45516: add protocol description to the Traversable documentation (GH-29039)Miss Islington (bot)2021-10-311-0/+40
| | | | | | | | | | | | | | | | | | | | * bpo-45516: add protocol description to the Traversable documentation Signed-off-by: Filipe Laíns <lains@riseup.net> * Update Doc/library/importlib.rst Co-authored-by: Jason R. Coombs <jaraco@jaraco.com> * Update Lib/importlib/abc.py * Update Doc/library/importlib.rst Co-authored-by: Jason R. Coombs <jaraco@jaraco.com> Co-authored-by: Jason R. Coombs <jaraco@jaraco.com> (cherry picked from commit 4d03de3329ed8daa9c1107b1aedbb0fa280bddb6) Co-authored-by: Filipe Laíns <filipe.lains@gmail.com>
* Fix docs source link for importlib.metadata (GH-29025)Miss Islington (bot)2021-10-301-1/+1
| | | | | | | | | | The link broke for Python 3.10 since importlib.metadata was made from a module into a package I think this is trivial enough to not need a bpo issue. Automerge-Triggered-By: GH:jaraco (cherry picked from commit aae18a17401dc36917c0f64f971d60ab1a5b477e) Co-authored-by: Philipp A <flying-sheep@web.de>
* bpo-45600: Enhanced / clarified the docs for os.environ and os.environb ↵Miss Islington (bot)2021-10-291-7/+8
| | | | | | | | (GH-29204) (GH-29322) Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit b17cfd150f4dc2816975d304a71110a2d445eaf0) Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
* bpo-45335: Add note to `sqlite3` docs about "timestamp" converter (GH-29200) ↵Miss Islington (bot)2021-10-291-0/+6
| | | | | | | (GH-29319) (cherry picked from commit 3877fc02f7a8801ba5ce0e94b6075b3fdd9778d0) Co-authored-by: Ian Fisher <ian@iafisher.com>
* bpo-45655: Add ref to union type expressions at top of typing docs (GH-29309)Miss Islington (bot)2021-10-291-1/+2
| | | | | (cherry picked from commit d9575218d7ab3d85b15ce3d4779660b9b724d343) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.10] bo-45655: Add "relevant PEPs" section to typing documentation (GH-29302)Alex Waygood2021-10-292-11/+45
| | | | | | | | | | | The list of PEPs at the top of the documentation for the ``typing`` module has become too long to be readable. This PR proposes presenting this information in a more structured and readable way by adding a new "relevant PEPs" section to the ``typing`` docs. (cherry picked from commit 03db1bbfd2d3f5a343c293b2f0e09a1e962df7ea) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* bpo-45583: Correct datamodel documentation of int() (GH-29182) (GH-29285)Miss Islington (bot)2021-10-281-2/+2
| | | | | | | It should be noted that this part of the documentation is redundant with function.rst's documentation of int. This one was correctly updated with Python 3.8. (cherry picked from commit d9c1868c25ec6466e8d8ae21fe9315a8a03836ab) Co-authored-by: Arthur Milchior <arthur@milchior.fr>
* bpo-45604: add `level` argument to `multiprocessing.log_to_stderr` func ↵Miss Islington (bot)2021-10-281-1/+2
| | | | | | | | (GH-29226) (GH-29283) Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> (cherry picked from commit 1fb968c07a76fb2d1ec8c14a0026f1d15828f4a5) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* bpo-45608: Document missing `sqlite3` DB-API attributes and methods ↵Miss Islington (bot)2021-10-281-0/+46
| | | | | | | (GH-29219) (GH-29281) (cherry picked from commit 88d8a1a340fb09c54d47f354f5fd7d4fbc5f0c78) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
* [3.10] bpo-28737: Document when tp_dealloc should call PyObject_GC_UnTrack() ↵Sam Gross2021-10-283-9/+33
| | | | | | | | | | (GH-29246) (GH-29249) Objects that support garbage collection ("container" objects) should call PyObject_GC_UnTrack() from their destructors before clearing any fields which may point to other "container" objects. (cherry picked from commit 35e1ff38ee67ee543d9fcb268c3552c5397f9b3f) Co-authored-by: Sam Gross <colesbury@gmail.com>