summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* Make the first dataclass example more useful (GH-19994) (GH-19997)Miss Islington (bot)2020-05-081-0/+2
| | | | | | | (cherry picked from commit 2effef7453986bf43a6d921cd471a8bc0722c36a) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* Remove outdated and confusing advice about setting maxsize (GH-19889) (GH-19890)Miss Islington (bot)2020-05-041-2/+1
|
* Fix missing space in docs(GH-19866) (GH-19872)Miss Islington (bot)2020-05-031-1/+1
|
* bpo-40419: timeit CLI docs now mention 1,2,5,10,... trials instead of powers ↵Miss Islington (bot)2020-05-021-1/+2
| | | | | | | of 10 (GH-19752) (cherry picked from commit 766352320fd736e2c8ed545b4cc57563f61a0b9d) Co-authored-by: Sander <svr003@gmail.com>
* [3.8] bpo-39435: Fix docs for pickle.loads (GH-18160) (GH-19843)Antoine Pitrou2020-05-011-2/+2
| | | | | | | (cherry picked from commit 289842a) Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com> Automerge-Triggered-By: @pitrou
* bpo-39691: Clarify io.open_code behavior (GH-19824)Miss Islington (bot)2020-05-011-4/+5
| | | | | (cherry picked from commit 831d58d7865cb98fa09227dc614f4f3ce6af968b) Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com>
* bpo-39562: Correctly updated the version section in the what's new document ↵Pablo Galindo2020-05-011-0/+3
| | | | (GH-19838)
* [3.8] bpo-39562: Prevent collision of future and compiler flags (GH-19230) ↵Pablo Galindo2020-05-011-0/+5
| | | | | | | | | | | (GH-19835) The constant values of future flags in the __future__ module is updated in order to prevent collision with compiler flags. Previously PyCF_ALLOW_TOP_LEVEL_AWAIT was clashing with CO_FUTURE_DIVISION.. (cherry picked from commit 4454057269b995341b04d13f0bf97f96080f27d0) Co-authored-by: Batuhan Taşkaya <batuhanosmantaskaya@gmail.com>
* bpo-40348: Fix typos in the programming FAQ (GH-19729)Miss Islington (bot)2020-04-271-2/+2
| | | | | (cherry picked from commit caf1aadf3d020f742ba3d7fcf678ca700224914b) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* [3.8] bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros ↵Zachary Ware2020-04-272-1/+34
| | | | | | | | | | | | (GH-16607) (GH-19727) Adds a short description of `PyDoc_STRVAR` and `PyDoc_STR` to "Useful macros" section of C-API docs. Currently, there is [one lone mention](https://docs.python.org/3/c-api/module.html?highlight=pydoc_strvarGH-c.PyModuleDef) in the C-API reference, despite the fact that `PyDoc_STRVAR` is ubiquitous to `Modules/`. Additionally, this properly uses `c:macro` within `Doc/c-api/module.rst` to link. (cherry picked from commit b54e46c) Authored-by: Brad Solomon <brad.solomon.1124@gmail.com>
* bpo-40387: Improve queue join() example. (GH-19724) (GH-19726)Miss Islington (bot)2020-04-271-16/+12
|
* bpo-40279: Add some error-handling to the module initialisation docs example ↵Miss Islington (bot)2020-04-251-3/+11
| | | | | | | (GH-19705) (GH-19710) (cherry picked from commit d4f3923d5901ef1ccdbe6ad6c5a753af90832a0f) Co-authored-by: Cajetan Rodrigues <caje731@gmail.com>
* Minor modernization and readability improvement to the tokenizer example ↵Miss Islington (bot)2020-04-221-2/+6
| | | | | (GH-19558) (GH-19661) (cherry picked from commit bf1a81258c0ecc8b52b9dcc53321c066b3ed4a67)
* Small improvements to the recipes and examples. (GH-19635) (GH-19638)Miss Islington (bot)2020-04-211-30/+26
| | | | | | | * Add underscores to long numbers to improve readability * Use bigger dataset in the bootstrapping example * Convert single-server queue example to more useful multi-server queue (cherry picked from commit d3a8d616faf3364b22fde18dce8c168de9368146)
* bpo-39285: Clarify example for PurePath.match (GH-19458)Miss Islington (bot)2020-04-191-1/+3
| | | | | | | | | | | | | | Fixes Issue39285 The example incorrectly returned True for match. Furthermore the example is ambiguous in its usage of PureWindowsPath. Windows is case-insensitve, however the underlying match functionality utilizes fnmatch.fnmatchcase. Automerge-Triggered-By: @pitrou (cherry picked from commit c12375aa0b838d34067efa3f1b9a1fbc632d0413) Co-authored-by: Tim Lo <timlo@users.noreply.github.com>
* bpo-27635: Fix pickle documentation about `__new__` not being called. (GH-19269)Miss Islington (bot)2020-04-181-3/+3
| | | | | | Automerge-Triggered-By: @pitrou (cherry picked from commit 482259d0dcf27714a84cf56b93977320bea7e093) Co-authored-by: Furkan Önder <furkantahaonder@gmail.com>
* Fix parameter names in assertIn() docs (GH-18829)Miss Islington (bot)2020-04-171-3/+3
| | | | | | The names "member" and "container" for the arguments are also used in the module and shown with the help() function, and are immediately understandable in this context, contrary to "first" and "second". (cherry picked from commit a388bbd3f129364c39843f63e92f08bc53c71905) Co-authored-by: Christoph Zwerschke <cito@online.de>
* [3.8] bpo-39667: Sync zipp 3.0 (GH-18540) (GH-18701)Miss Islington (bot)2020-04-151-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | * bpo-39667: Sync zipp 3.0 (GH-18540) * bpo-39667: Improve pathlib.Path compatibility on zipfile.Path and correct performance degradation as found in zipp 3.0 * 📜🤖 Added by blurb_it. * Update docs for new zipfile.Path.open * Rely on dict, faster than OrderedDict. * Syntax edits on docs Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> (cherry picked from commit 0aeab5c4381f0cc11479362af2533b3a391312ac) Co-authored-by: Jason R. Coombs <jaraco@jaraco.com> * Clarify the change in behavior with a couple of workaround options. * Restore API compatibility while backporting performance improvements. Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
* [3.8] Improved documentation for `BUILD_CONST_KEY_MAP` (GH-19454) (GH-19495)Miss Islington (bot)2020-04-131-3/+3
| | | | | | | | (cherry picked from commit 85dd6bb1f61f7edcd6ac0b640a98644531690a0e) Co-authored-by: laike9m <laike9m@users.noreply.github.com> Automerge-Triggered-By: @zhangyangyu
* bpo-38501: Add a warning section to multiprocessing.Pool docs about resource ↵Miss Islington (bot)2020-04-111-1/+12
| | | | | | | managing (GH-19466) (cherry picked from commit 7ec43a73092d43c6c95e7dd2669f49d54b57966f) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
* bpo-40197: Better describe the benchmark results table (GH-19386)Miss Islington (bot)2020-04-101-1/+7
| | | | | (cherry picked from commit c63629e7c09da80a6b7d0253d04a9b3f57f88eff) Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
* bpo-40204: Pin Sphinx version to 1.8.2 in Doc/Makefile (GH-19442)Victor Stinner2020-04-081-1/+1
|
* Fix misinformation about NaN != NaN comparison (GH-19357) (GH-19383)Miss Islington (bot)2020-04-051-2/+3
| | | | | | (cherry picked from commit 810f68f1282c917fc1ad6af540a9f08524dfe310) Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
* bpo-36320: Use the deprecated-removed directive for _field_types (GH-19370)Serhiy Storchaka2020-04-041-1/+1
|
* bpo-40131: Fix source and target order in zipapp example (GH-19290) (GH-19339)Miss Islington (bot)2020-04-031-1/+1
| | | | | | (cherry picked from commit bd6a4c3d72828d3d0e13922e165998539d24f8bc) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-40122: Updated documentation for dis.findlabels() (GH-19274)Miss Islington (bot)2020-04-031-1/+1
| | | | | (cherry picked from commit b74468e233a5137ff518e61eff65ca2d8833e38a) Co-authored-by: laike9m <laike9m@users.noreply.github.com>
* bpo-38972: Link to instructions to change PowerShell execution policy (GH-19131)Miss Islington (bot)2020-04-021-0/+11
| | | | | (cherry picked from commit 45217af29c7f380089af17beb48a5ea0560bbb9d) Co-authored-by: Derek Keeler <d3r3kk@users.noreply.github.com>
* bpo-40094: Enhance os.WIFEXITED documentation (GH-19244) (GH-19277)Miss Islington (bot)2020-04-011-10/+24
| | | | | (cherry picked from commit 7c72383f95b0cdedf390726069428d7b69ed2597) Co-authored-by: Victor Stinner <vstinner@python.org>
* Document most common signals (GH-19245) (GH-19257)Victor Stinner2020-03-311-0/+106
| | | | | | Document individual signals (only the most common signals): description, default action, availability. (cherry picked from commit 400e1dbcad93061f1f7ab4735202daaa5e731507)
* fix comma location in various places (GH-19233)Miss Islington (bot)2020-03-308-9/+9
| | | | | (cherry picked from commit c49016e67c3255b37599b354a8d7995d40663991) Co-authored-by: Mathieu Dupuy <deronnax@users.noreply.github.com>
* bpo-40045: Make "dunder" method documentation easier to locate (GH-19153) ↵Miss Islington (bot)2020-03-271-5/+5
| | | | | | | | | | | | | | | | (GH-19198) * issue 40045 * Update lexical_analysis.rst Make "dunder" method documentation easier(GH-19153) Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com> (cherry picked from commit 5f9c131c099d6675d1a9d0228497865488afd548) Co-authored-by: Javad Mokhtari <javadmokhtari@outlook.com> Co-authored-by: Javad Mokhtari <javadmokhtari@outlook.com>
* bpo-38237: Use divmod for positional arguments whatsnew example (GH-19171)Miss Islington (bot)2020-03-271-5/+4
| | | | | (cherry picked from commit 5a58c5280b8df4ca5d6a19892b24fff96e9ea868) Co-authored-by: Ammar Askar <ammar@ammaraskar.com>
* bpo-19698: Document when importlib.machinery.FrozenImporter gained ↵Miss Islington (bot)2020-03-261-0/+4
| | | | | | | | | spec-related methods (GH-19158) (#19164) (cherry picked from commit 302e5a8f79514fd84bafbc44b7c97ec636302322) Co-authored-by: Brett Cannon <54418+brettcannon@users.noreply.github.com> Co-authored-by: Brett Cannon <54418+brettcannon@users.noreply.github.com>
* bpo-39879: Update datamodel docs to include dict ordering (GH-19006)Miss Islington (bot)2020-03-261-0/+10
| | | | | | Co-authored-by: furkanonder <furkantahaonder@gmail.com> (cherry picked from commit 59c644eaa72b0cc48302f59d66852c4ea8332eba) Co-authored-by: Lahfa Samy <lahfa121999@gmail.com>
* bpo-40013: Clarify documentation of restval in csv.DictReader (GH-19099) ↵Miss Islington (bot)2020-03-251-1/+2
| | | | | | | | (GH-19141) (cherry picked from commit 4b3252cb764807fdb3a661b458d43e4af55cf4df) Co-authored-by: Juhana Jauhiainen <juhana.jauhiainen@gmail.com>
* Clarify a guarantee of the logging module. (GH-19132)Miss Islington (bot)2020-03-241-0/+1
| | | | | | | When no additional arguments are passed to logging.debug() and related methods, no % operation is performed on the passed in message. (cherry picked from commit 9b8e74ca77da7167033917d155e5f55c67b92f14) Co-authored-by: Gregory P. Smith <greg@krypto.org>
* bpo-39652: Truncate the column name after '[' only if PARSE_COLNAMES is set. ↵Miss Islington (bot)2020-03-211-3/+4
| | | | | | | (GH-18942) (cherry picked from commit b146568dfcbcd7409c724f8917e4f77433dd56e4) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* bpo-39797 Changes to socketserver.BaseServer's shutdown() method. (GH-18929)Miss Islington (bot)2020-03-201-0/+2
| | | | | | Automerge-Triggered-By: @ned-deily (cherry picked from commit 2de7ac97981c30e9c1001b05a771f52a41772c54) Co-authored-by: amaajemyfren <32741226+amaajemyfren@users.noreply.github.com>
* Fix "versionchanged" for pow named arguments (GH-19042) (GH-19079)Miss Islington (bot)2020-03-191-1/+1
| | | | | | | The ability to use named arguments in "pow" was introduced in Python 3.8, not Python 3.9. See https://bugs.python.org/issue38237 (cherry picked from commit c691f209523e20797c7b696c3f171b37429f5b3f) Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
* bpo-39973: Fix the docs for PyObject_GenericSetDict() (GH-19026)Miss Islington (bot)2020-03-172-2/+3
| | | | | | PyObject_GenericSetDict() takes three arguments, not two. (cherry picked from commit a45b695b9fcfbbb0a087222abc5c8d691a7d2770) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-39869: Fix typo in 'Instance objects' section. (GH-18889)Miss Islington (bot)2020-03-141-1/+1
| | | | | (cherry picked from commit e5e56328afac50aad6d8893185d8e7ba8928afe2) Co-authored-by: Antoine <43954001+awecx@users.noreply.github.com>
* Link to list of keywords in the laguage reference (GH-18024)Miss Islington (bot)2020-03-141-5/+6
| | | | | (cherry picked from commit 33238ec2af379e837cabc3945db5df8e23bf43e9) Co-authored-by: Борис Верховский <boris.verk@gmail.com>
* bpo-39677: dis: rename the operand of MAKE_FUNCTION from `argc` to `flags` ↵Miss Islington (bot)2020-03-141-1/+1
| | | | | | | for 3.6+ (GC-18550) (cherry picked from commit 6672c16b1d7f83789bf3a2016bd19edfd3568e71) Co-authored-by: Taine Zhao <twshere@outlook.com>
* [3.8] Doc: Fix grammar in PyErr_ResourceWarning (GH-18879) (GH-18976)Karthikeyan Singaravelan2020-03-131-1/+1
| | | | | (cherry picked from commit fdcd53f) Co-authored-by: Daniel Hahler <git@thequod.de>
* Fix syntax error in an example in the ast documentation and sync docstrings ↵Miss Islington (bot)2020-03-121-1/+1
| | | | | | | (GH-18946) (cherry picked from commit c00c86b90443dbf3534cc4786a0b42b58db6e8af) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
* Fix download.html (GH-18902)Miss Islington (bot)2020-03-111-1/+1
| | | | | | | | `<tt>` is not allowed. Co-authored-by: Kyle Stanley <aeros167@gmail.com> (cherry picked from commit 39c34933fc958fd773ebf14ccd2e0224450b17ed) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* tracemalloc: 'pretty top' example no longer changes the filename (GH-18903)Miss Islington (bot)2020-03-101-3/+1
| | | | | | | | I've used this recipe a couple times and the filename editing has always been less than useful and something I've removed. This is because many modules end up losing which package they are located in, e.g. `util/date.py`. (cherry picked from commit d06eec218eac81225f9017951cddfc211fed9325) Co-authored-by: Adam Johnson <me@adamj.eu>
* bpo-39852: IDLE 'Go to line' deletes selection, updates status (GH-18801)Miss Islington (bot)2020-03-081-1/+3
| | | | | | | | It appears standard that moving the text insert cursor away from a selection clears the selection. Clearing prevents accidental deletion of a possibly off-screen bit of text. The update is for Ln and Col on the status bar. (cherry picked from commit 2522db11df102be3baf25ce9e816ebe8ffdb7fcc) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* fix typo: add space (GH-18853)Miss Islington (bot)2020-03-081-2/+2
| | | | | | | Fix typo in cmdline.rst Add space between the `-m` option and the module name (`timeit`). (cherry picked from commit c580981ba01c4d9f721dbdd88208ba37704e0217) Co-authored-by: Julin S <48789920+ju-sh@users.noreply.github.com>
* bpo-17422: slightly more precise language (GH-18682)Miss Islington (bot)2020-03-061-1/+1
| | | | | (cherry picked from commit e59334ebc9308b0f3ad048ef293c6b49e6456d1a) Co-authored-by: Caleb Donovick <cdonovick@users.noreply.github.com>