summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* [3.11] gh-93883: elide traceback indicators when possible (GH-93994) (GH-94740)John Belmonte2022-07-112-10/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Elide traceback column indicators when the entire line of the frame is implicated. This reduces traceback length and draws more attention to the remaining (very relevant) indicators. Example: ``` Traceback (most recent call last): File "query.py", line 99, in <module> bar() File "query.py", line 66, in bar foo() File "query.py", line 37, in foo magic_arithmetic('foo') File "query.py", line 18, in magic_arithmetic return add_counts(x) / 25 ^^^^^^^^^^^^^ File "query.py", line 24, in add_counts return 25 + query_user(user1) + query_user(user2) ^^^^^^^^^^^^^^^^^ File "query.py", line 32, in query_user return 1 + query_count(db, response['a']['b']['c']['user'], retry=True) ~~~~~~~~~~~~~~~~~~^^^^^ TypeError: 'NoneType' object is not subscriptable ``` Automerge-Triggered-By: GH:pablogsal
* GH-77265: Document NaN handling in statistics functions that sort or count ↵Miss Islington (bot)2022-07-101-0/+29
| | | | (GH-94676) (#94726)
* Use mdash-es consistently in the library docs index (GH-92762)Miss Islington (bot)2022-07-081-4/+4
| | | | | (cherry picked from commit efb20a97c491821acb03564f526afaf9eed47eef) Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
* [3.11] gh-94622: Add more references to the sqlite3 types anchor (GH-94623) ↵Erlend Egeberg Aasland2022-07-081-8/+8
| | | | | | | (#94678) (cherry picked from commit e5b841a4037d1c2ce3d12a584facf800ae36332a) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
* gh-94321: Document sqlite3.PrepareProtocol (GH-94620)Miss Islington (bot)2022-07-071-0/+12
| | | | | (cherry picked from commit fb6dccae348b954d9f625031b54711a9a33da525) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
* [3.11] gh-94628: Add explicit parameter list to sqlite3.connect docs ↵Erlend Egeberg Aasland2022-07-071-76/+105
| | | | | | | | (GH-94629) (#94645) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM> (cherry picked from commit 3eb2b9634fdc6826a558fa5aa820dc6e69b7800e) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
* gh-94630: Update sqlite3 docs with positional-only and keyword-only symbols ↵Miss Islington (bot)2022-07-061-11/+11
| | | | | | | (GH-94631) (cherry picked from commit 94988603f3c934f95220f09aefffd50c0a5d3367) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
* gh-94017: Improve clarity of sqlite3 transaction handling docs (GH-94320)Miss Islington (bot)2022-07-061-39/+61
| | | | | | | Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM> (cherry picked from commit 760b8cf0c887fbc5191611a7e7d4b8c0c4f15edc) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
* gh-91330: Tests and docs for dataclass descriptor-typed fields (GH-94424) ↵Miss Islington (bot)2022-07-051-0/+51
| | | | | | | | (GH-94576) Co-authored-by: Erik De Bonte <erikd@microsoft.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit 5f319308a820f49fec66fc3ade50bbaa9fe2105d)
* Docs: Convert PEP 630 (Isolating Extension Modules) to a HOWTO (GH-94489) ↵Miss Islington (bot)2022-07-052-0/+537
| | | | | | | | | | (GH-94566) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Petr Viktorin <encukou@gmail.com> (cherry picked from commit e6ec6f5b50e8793172e83a9afbb05fe01f236b37)
* [3.11] bpo-46755: Don't log stack info twice in QueueHandler (GH-31355) ↵Miss Islington (bot)2022-07-051-1/+1
| | | | | (GH-94564) Co-authored-by: Erik Montnemery <erik@montnemery.com>
* Docs: remove redundant "adverb-adjective" hyphens from compound modifiers ↵Miss Islington (bot)2022-07-0564-111/+111
| | | | | | | | (GH-94551) (GH-94557) Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021 (cherry picked from commit 3440d197a55800ecceea3e115e44b4262411359c) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* gh-93626: Set the release for `__future__.annotations` to `None` (GH-93628) ↵Miss Islington (bot)2022-07-051-0/+7
| | | | | | | | (GH-94553) Co-authored-by: Guido van Rossum <gvanrossum@gmail.com> (cherry picked from commit 4791a8a8357e67431cb686d9559aa419074b8e33) Co-authored-by: KotlinIsland <65446343+KotlinIsland@users.noreply.github.com>
* [3.11] Update logging documentation: change cross-reference and add webapp ↵Vinay Sajip2022-07-042-2/+271
| | | | r… (GH-94541)
* IDLE doc: Tweek RESTART and Windows console start (GH-94530)Miss Islington (bot)2022-07-031-2/+4
| | | | | (cherry picked from commit 39c29f753e6d6f390dce5a36613c1e03f43d28ea) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* gh-81054: Document that SimpleHTTPRequestHandler follows symbolic links ↵Miss Islington (bot)2022-07-012-2/+13
| | | | | | | (GH-94416) (GH-94492) (cherry picked from commit 80aaeabb8bd1e6b49598a7e23e0f8d99b3fcecaf) Co-authored-by: Sam Ezeh <sam.z.ezeh@gmail.com>
* Update code sample when importing modules in queue doc (GH-94244) (GH-94490)Miss Islington (bot)2022-07-011-1/+2
| | | | | | | | In the queue documentation, the code snippet shows the import to be not PEP 8 compliant. Since people typically copy-paste from such code samples, I think it's important to show best-practices here. (cherry picked from commit ad55147c1d5dbfc23d2ec4554f5e82c18984158c) Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
* multiprocessing.spawn doc: Capitalize the p in "Python" (gh-94462)Miss Islington (bot)2022-06-301-1/+1
| | | | | (cherry picked from commit 62bb7a3b50150495e215d7bd32f633eef81b3bc2) Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
* GH-94398: TaskGroup: Fail create_task() during shutdown (GH-94400) (GH-94463)Miss Islington (bot)2022-06-301-0/+1
| | | | | | | | | | Once the task group is shutting down, it should not be possible to create a new task. Here "shutting down" means `self._aborting` is set, indicating that at least one task has failed and we have cancelled all others. Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit 594c3699492bfb007650538726d953cbed55de04) Co-authored-by: Guido van Rossum <guido@python.org>
* xml.dom.minidom docs: fix typo (GH-93437)Miss Islington (bot)2022-06-301-1/+1
| | | | | (cherry picked from commit 639e35108bc8b2b880225862d3571277ad57648b) Co-authored-by: Jean-Christophe Helary <jean.christophe.helary@traduction-libre.org>
* GH-90908: Document asyncio.TaskGroup (GH-94359) (GH-94456)Miss Islington (bot)2022-06-302-2/+106
| | | | | | Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM> (cherry picked from commit b6ec6d4041a5d937f0b63764a329582af4948a3c) Co-authored-by: Guido van Rossum <guido@python.org>
* [3.11] gh-89038: [doc] update dis.findlinestarts documentation for changes ↵Irit Katriel2022-06-301-4/+6
| | | | | | | related to PEP-626 (GH-94247) (GH-94450) (cherry picked from commit d68f2d27bbf85f3573a08fc7554889e1733a30f0) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
* bpo-92336: [doc] clarify that the dfile is read by the traceback display ↵Miss Islington (bot)2022-06-291-2/+3
| | | | | | | code (GH-94409) (cherry picked from commit 68fb03249f3b17146db42b00a75718b823a2280c) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
* Docs: Update SyntaxError message in REPL example for list comprehension ↵Miss Islington (bot)2022-06-291-3/+3
| | | | | | | (GH-93901) (GH-94425) (cherry picked from commit 22b783aba05bcc3a21af9e5ae308ffbb98ff6a12) Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
* [3.11] GH-93516: Backport GH-93769 (GH-94231)Mark Shannon2022-06-281-157/+160
| | | * Store offset of first traceable instruction to avoid having to recompute it all the time when tracing.
* gh-61585: Clarify import scope in modules tutorial (GH-93455) (GH-94373)Miss Islington (bot)2022-06-281-10/+11
| | | | | | | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> (cherry picked from commit 4b854b746650214eddadb2440efd9e1544d08ccb)
* [3.11] gh-86404: [doc] Fix missing space in idle documentation. (GH-94366) ↵Miss Islington (bot)2022-06-281-1/+1
| | | | | | | | | | | | | (GH-94369) This should have been spotted by sphinx-lint, tracked here: https://github.com/sphinx-contrib/sphinx-lint/issues/39 (cherry picked from commit bc7f6fcdf14da32a8f7816ace800a6a91dc1554f) Co-authored-by: Julien Palard <julien@palard.fr> Automerge-Triggered-By: GH:JulienPalard
* gh-91860: Add docs for typing.dataclass_transform field specifier params ↵Miss Islington (bot)2022-06-281-1/+35
| | | | | | | (GH-94354) (GH-94372) (cherry picked from commit 81ac9ac4921c57c8f31464fed575ea0cfe84df70) Co-authored-by: Erik De Bonte <erikd@microsoft.com>
* gh-82006: IDLE doc improvements (GH-94349)Miss Islington (bot)2022-06-271-11/+24
| | | | | | | | 0. Update text start and stop conditions. 1. Title-case sections but not subsections. 2. Edit Shell Window sections: title, execute, restart. (cherry picked from commit e6391e08bff775a3c10707fd2cfce6963e6ae429) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* [3.11] gh-85023: [doc] clarify parameters vs arguments explanation in FAQ ↵Irit Katriel2022-06-261-2/+3
| | | | | | | | | (GH-94282) (GH-94311) (cherry picked from commit d71f5adc41569c2d626552269797e0545fc9122c) Co-authored-by: Arun Mani J <49952138+arun-mani-j@users.noreply.github.com> Co-authored-by: Arun Mani J <49952138+arun-mani-j@users.noreply.github.com>
* [3.11] [doc] fix typo in reference to tp_descr_get and tp_descr_set ↵Irit Katriel2022-06-261-2/+2
| | | | | | | | | (GH-94140) (GH-94293) (cherry picked from commit 32d595fdcd4be8e1f41dcfe84ccf4de89fea3c3f) Co-authored-by: Max Bachmann <kontakt@maxbachmann.de> Co-authored-by: Max Bachmann <kontakt@maxbachmann.de>
* gh-70474: [doc] fix wording of GET_ANEXT doc (GH-94048)Miss Islington (bot)2022-06-251-2/+2
| | | | | (cherry picked from commit 9af6b75298d066e89646acf8df1704bef183a6f8) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
* bpo-39971: Change examples to be runnable (GH-32172)Miss Islington (bot)2022-06-251-11/+18
| | | | | (cherry picked from commit c57a1c76d71075b14f6524b4681f29a3f1e88cb2) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* [3.11] gh-90016: Reword sqlite3 adapter/converter docs (GH-93095) (#94272)Erlend Egeberg Aasland2022-06-253-111/+145
| | | | | | | Also add adapters and converter recipes. Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com. (cherry picked from commit bd3c1c187e0e4fde5aec6835d180e9eddde8ceb6)
* Docs: Remove `Provides [...]` from `multiprocessing.shared_memory` ↵Miss Islington (bot)2022-06-241-2/+2
| | | | | | | description (GH-92761) (cherry picked from commit a91ffcf3fa15ce3884f620c799566aa734412f9d) Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
* [3.11] gh-93382: Cache result of `PyCode_GetCode` in codeobject (GH-93383) ↵Ken Jin2022-06-231-524/+527
| | | | | | (#93493) Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com> Co-authored-by: Dennis Sweeney <36520290+sweeneyde@users.noreply.github.com>
* [3.11] gh-86404: [doc] Fix missing backtick and double target name. ↵Julien Palard2022-06-231-2/+2
| | | | | | | (GH-94120) (GH-94159) (cherry picked from commit 11e865c74baa45ac9eda69f2f6af05505fc03ce5) Co-authored-by: Julien Palard <julien@palard.fr>
* gh-91456: [Enum] Deprecate default auto() behavior with mixed value types ↵Miss Islington (bot)2022-06-231-0/+4
| | | | | | | | | | (GH-91457) When used with plain Enum, auto() returns the last numeric value assigned, skipping any incompatible member values (such as strings); starting in 3.13 the default auto() for plain Enums will require all the values to be of compatible types, and will return a new value that is 1 higher than any existing value. Co-authored-by: Ethan Furman <ethan@stoneleaf.us> (cherry picked from commit fb1e9506c14ef32d5bec126dad6fa769c8c054f6) Co-authored-by: Oscar R <89599049+oscar-LT@users.noreply.github.com>
* Closes gh-94152: Update pyvideo.org URL (GH-94075)Miss Islington (bot)2022-06-231-1/+1
| | | | | | The URL is now https://pyvideo.org, which uses HTTPS and avoids a redirect. (cherry picked from commit 7c439dca13435085efb2fddf9ac75e5305db7ada) Co-authored-by: partev <petrosyan@gmail.com>
* gh-94114: Remove obsolete reference to python.org mirrors (GH-94115)Miss Islington (bot)2022-06-221-4/+1
| | | | | | * gh-94114 (cherry picked from commit 8661c5053fbe3e246289d77e49a813470b3a16f7) Co-authored-by: partev <petrosyan@gmail.com>
* [3.11] GH-93516: Backport GH-93769: Speedup line number checks when tracing ↵Mark Shannon2022-06-221-290/+308
| | | | | (GH-94127) Co-authored-by: Pablo Galindo <pablogsal@gmail.com>
* gh-74696: Do not change the current working directory in ↵Miss Islington (bot)2022-06-221-1/+7
| | | | | | | | | | | | | | shutil.make_archive() if possible (GH-93160) (GH-94105) It is no longer changed when create a zip or tar archive. It is still changed for custom archivers registered with shutil.register_archive_format() if root_dir is not None. Co-authored-by: Éric <merwok@netwok.org> Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit fda4b2f06364ae5ef91ecd9c09e2af380c8b0b4c) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* bpo-30535: [doc] state that sys.meta_path is not empty by default (GH-94098) ↵Miss Islington (bot)2022-06-211-1/+2
| | | | | | | | | | (GH-94099) Co-authored-by: Windson yang <wiwindson@outlook.com> (cherry picked from commit 6575841266b83f3121c188695c7513e551ade034) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com> Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
* gh-92611: Add details on replacements for cgi utility funcs (GH-92792) ↵Miss Islington (bot)2022-06-211-0/+31
| | | | | | | | | (GH-93967) Per [suggestions on a Discourse thread](https://discuss.python.org/t/pep-594-take-2-removing-dead-batteries-from-the-standard-library/13508/51), discussed in GH-92611 and as a followup to PR GH-92612 , this PR add additional specific per-function replacement information for the utility functions in the `cgi` module deprecated by PEP 594 (PEP-594). (cherry picked from commit 71354adff07f8beba8374767532bb9da34546e66) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
* Tutorial: specify match cases don't fall through (GH-93615) (GH-94083)Miss Islington (bot)2022-06-211-2/+4
| | | | | (cherry picked from commit dd5cf84f245abf84405833320b8f25dbc43b24d2) Co-authored-by: max <36980911+pr2502@users.noreply.github.com>
* [3.11] gh-93240: clarify wording in IO tutorial (GH-93276) (GH-94082)Łukasz Langa2022-06-211-1/+1
| | | | | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> (cherry picked from commit 51d673176ac90f2144e3e7a492e5b3ea53bdba2e) Co-authored-by: paulreece <96156234+paulreece@users.noreply.github.com>
* [3.11] gh-93675: Fix typos in `Doc/` (GH-93676) (GH-94079)Łukasz Langa2022-06-215-5/+5
| | | | | | Closes GH-93675 (cherry picked from commit 830513754d081619b2d72db17770627312072fa5) Co-authored-by: luzpaz <luzpaz@users.noreply.github.com>
* gh-93851: Fix all broken links in Doc/ (GH-93853) (GH-94076)Miss Islington (bot)2022-06-2130-47/+59
| | | | | (cherry picked from commit f62ff97f31a775cc7956adeae32c14e7c85bdc15) Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
* gh-86986: Drop compatibility support for Sphinx 2 (GH-93737)Miss Islington (bot)2022-06-2111-52/+18
| | | | | | | | | | | | * Revert "bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)" This reverts commit 5c1f15b4b1024cbf0acc85832f0c623d1a4605fd * Revert "bpo-42579: Make workaround for various versions of Sphinx more robust (GH-23662)" This reverts commit b63a620014b67a6e63d10783149c41baaf59def8. (cherry picked from commit 0efe3a1636c143fe0694a8e4d25d6eae19e0d618) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* gh-90539: doc: Expand on what should not go into CFLAGS, LDFLAGS (GH-92754)Miss Islington (bot)2022-06-201-0/+18
| | | | | (cherry picked from commit 61f24e7885bed096b5d7f75aff13c1001994b35a) Co-authored-by: Matthias Köppe <mkoeppe@math.ucdavis.edu>