summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* bpo-40204: Pin Sphinx version to 2.3.1 in Doc/MakefileNed Deily2020-06-171-1/+1
|
* [3.7] bpo-37674: Tweak imp module deprecation note in the docs (GH-20480) ↵Miss Islington (bot)2020-06-131-1/+1
| | | | | | | | | | (GH-20861) (cherry picked from commit dea3223740127ac13f984c1d38f127ab6701af44) Co-authored-by: Zackery Spytz <zspytz@gmail.com> Automerge-Triggered-By: @brettcannon
* bpo-40025: Require _generate_next_value_ to be defined before members (GH-19762)Miss Islington (bot)2020-06-111-0/+4
| | | | require `_generate_next_value_` to be defined before members (cherry picked from commit d9a43e20facdf4ad10186f820601c6580e1baa80)
* [3.7] bpo-40895: Update weakref documentation to remove old warnings ↵Antoine Pitrou2020-06-101-14/+0
| | | | | | | | | | | | | | | | | (GH-20687) (GH-20793) The doccumentation at https://docs.python.org/3.10/library/weakref.html cautions that the `WeakKeyDictionary` and `WeakValueDictionary` are susceptible to the problem of dictionary mutation during iteration. These notes present the user with a problem that has no easy solution. I dug into the implementation and found that fortunately, Antoine Pitrou already addressed this challenge (10 years ago!) by introducing an `_IterationGuard` context manager to the implementation, which delays mutation while an iteration is in progress. I asked for confirmation and @pitrou agreed that these notes could be removed: https://github.com/python/cpython/commit/c1baa601e2b558deb690edfdf334fceee3b03327GH-commitcomment-39514438. (cherry picked from commit 1642c0ef750f96664a98cadb09301d492098d2fb) Co-authored-by: Daniel Fortunov <asqui@users.noreply.github.com> Automerge-Triggered-By: @pitrou
* [3.7] Revert bpo-39576: docs: set context for decimal arbitrary precision ↵Stefan Krah2020-06-081-58/+8
| | | | | arithmetic (GH-20746) This reverts commit 00e45877e33d32bb61aa13a2033e3bba370bda4d.
* [3.7] Revert bpo-39576: Clarify the word size for the 32-bit build. (GH-20744)Stefan Krah2020-06-081-2/+2
| | | This reverts commit 24c570bbb82a7cb70576c253a73390accfa7ed78.
* bpo-22021: Update root_dir and base_dir documentation in shutil (GH-10367)Miss Islington (bot)2020-06-081-3/+47
| | | | | | | | Also added an example in shutil in order to make more clear how they are to be used. Initially reported by Weinan Li on bpo. (cherry picked from commit 7633371dace67aaa21eb4b86f889441571ec4167) Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
* Fix spacing in docs for tarfile (GH-20629)Miss Islington (bot)2020-06-041-1/+1
| | | | | | | | | | | | | | | | | | | | Before ``` content.txt is 42 bytes in size and isa regular file. folder is 420 bytes in size and isa directory. magic is 4200 bytes in size and issomething else. ``` After: ``` content.txt is 42 bytes in size and is a regular file. folder is 420 bytes in size and is a directory. magic is 4200 bytes in size and is something else. ``` Automerge-Triggered-By: @orsenthil (cherry picked from commit 7a280197f4162e5fcdde6f34701a9fa6e669190d) Co-authored-by: Harsha Laxman <HarshaLaxman@users.noreply.github.com>
* Ensure correct version of Sphinx is used for Windows builds (GH-20582)Miss Islington (bot)2020-06-011-1/+1
| | | | | (cherry picked from commit fe5dd78182dbf4937bcc2b113ca7526bfad0192b) Co-authored-by: Steve Dower <steve.dower@python.org>
* bpo-40831: Remove an incorrect statement in the Windows docs (GH-20570)Miss Islington (bot)2020-06-011-3/+1
| | | | | (cherry picked from commit c8966667bbdb284c3780ef6cec8a3870935a6bb7) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-40798: Generate a different message for already removed elements (GH-20483)Miss Islington (bot)2020-05-302-2/+12
| | | | | (cherry picked from commit 735d902b363b759df9ff00e58bbf4f7e2bde78cd) Co-authored-by: Florian Dahlitz <f2dahlitz@freenet.de>
* closes bpo-29017: Update the bindings for Qt information with PySide2 (GH-20149)Miss Islington (bot)2020-05-301-5/+6
| | | | | | Reference to PySide has been removed has it is for Qt 4, which has reached end of life. (cherry picked from commit 4649202ea75d48e1496e99911709824ca2d3170e) Co-authored-by: Samuel Gaist <samuel.gaist@idiap.ch>
* Improve IO tutorial's "Old string formatting" section (GH-16251)Miss Islington (bot)2020-05-281-5/+5
| | | | | | | | * Use a more universal explanation of string interpolation rather than specifically referencing sprintf(), which depends on the reader having a C background. Co-authored-by: Kyle Stanley <aeros167@gmail.com> (cherry picked from commit eaca2aa117d663acf8160a0b4543ee2c7006fcc7) Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
* [3.7] bpo-38580: Document that select() accepts iterables, not just ↵Tal Einat2020-05-261-3/+3
| | | | | | | sequences (GH-16832) (cherry picked from commit 372ee27d4958302dac7ad6a8711f6fd04771b2e6) Co-authored-by: Jakub Stasiak <jakub@stasiak.at>
* bpo-39301: State that floor division is used for right shift operations ↵Miss Islington (bot)2020-05-261-4/+2
| | | | | | | | | | | | (GH-20347) (GH-20416) * bpo-39301: State that floor division is used for right shift operations * Remove "without overflow check" (cherry picked from commit af7553ac95a96713be847dd45bc5a8aeb0a75955) Co-authored-by: Zackery Spytz <zspytz@gmail.com> Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-40439: Update broken link in lexical analysis docs (GH-20184)Miss Islington (bot)2020-05-231-1/+1
| | | | | | Automerge-Triggered-By: @csabella (cherry picked from commit af23f0d3cf19343512e6ca1fe1d46a5dbe425719) Co-authored-by: Matteo Bertucci <matteobertucci2004@gmail.com>
* [3.7] [doc] Remove references to obsolete BuildApplet on macOS (GH-20023) ↵Miss Islington (bot)2020-05-211-8/+2
| | | | | | | | | | (GH-20306) (cherry picked from commit 7864f11cdf12807555d62c7a132c191eb41ecc02) Co-authored-by: Andre Delfino <adelfino@gmail.com> Automerge-Triggered-By: @ned-deily
* [3.7] Doc: Python 3.10 in sidebar and version switcher. (GH-20209) (GH-20223)Miss Islington (bot)2020-05-192-2/+4
| | | | | | | | (cherry picked from commit 19e3e0026417caa92ffe21a67157363b45da9aa2) Co-authored-by: Julien Palard <julien@palard.fr> Automerge-Triggered-By: @JulienPalard
* bpo-39976: Add **other_popen_kwargs to subprocess docs (GH-20145)Miss Islington (bot)2020-05-191-4/+8
| | | | | (cherry picked from commit 46545000c2a30b46aed717b546bc09e5bae7148f) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* Doc: change 'Posix' for 'POSIX' (GH-20001)Miss Islington (bot)2020-05-173-6/+6
| | | | | (cherry picked from commit 65460565df99fbda6a74b6bb4bf99affaaf8bd95) Co-authored-by: Mathieu Dupuy <mathieu.dupuy@doctolib.com>
* bpo-38872: Document exec symbol for codeop.compile_command (GH-20047) (#20099)Miss Islington (bot)2020-05-152-4/+5
| | | | | | | | | | | | * Document exec symbol for codeop.compile_command * Remove extra statements Co-authored-by: nanjekyejoannah <joannah.nanjekye@ibm.com> (cherry picked from commit 7ba1f75f3f02b4b50ac6d7e17d15e467afa36aac) Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com> Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
* Make the first dataclass example more useful (GH-19994) (GH-19998)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>
* 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.7] bpo-39435: Fix docs for pickle.loads (GH-18160). (GH-19844)Antoine Pitrou2020-05-011-2/+2
| | | | | | | (cherry picked from commit 289842ae820f99908d3a345f1f3b6d4e5b4b97fc) Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com> Automerge-Triggered-By: @pitrou
* 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.7] bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros ↵Zachary Ware2020-04-272-1/+34
| | | | | | | | | | | | (GH-16607) (GH-19728) 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 b54e46cb57ebac5c525a9a6be241412cd57bc935) Co-authored-by: Brad Solomon <brad.solomon.1124@gmail.com>
* 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.7] Improved documentation for `BUILD_CONST_KEY_MAP` (GH-19454) (GH-19496)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-40204: Pin Sphinx version to 1.8.2 in Doc/Makefile (GH-19442) (GH-19443)Victor Stinner2020-04-091-1/+1
| | | (cherry picked from commit 37a257c0ae0d4ba746397ae7584db887b175ab24)
* Fix misinformation about NaN != NaN comparison (GH-19357) (GH-19384)Miss Islington (bot)2020-04-051-2/+3
| | | | | | (cherry picked from commit 810f68f1282c917fc1ad6af540a9f08524dfe310) Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
* bpo-40131: Fix source and target order in zipapp example (GH-19290) (GH-19340)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-40094: Enhance os.WIFEXITED documentation (GH-19244) (GH-19278)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-19258)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-19199) * 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-19698: Document when importlib.machinery.FrozenImporter gained ↵Miss Islington (bot)2020-03-261-0/+4
| | | | | | | | | spec-related methods (GH-19158) (GH-19165) (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-19142) (cherry picked from commit 4b3252cb764807fdb3a661b458d43e4af55cf4df) Co-authored-by: Juhana Jauhiainen <juhana.jauhiainen@gmail.com>
* [3.7] bpo-39652: Truncate the column name after '[' only if PARSE_COLNAMES ↵Serhiy Storchaka2020-03-211-3/+4
| | | | | | is set. (GH-18942). (GH-19104) (cherry picked from commit b146568dfcbcd7409c724f8917e4f77433dd56e4)
* 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>
* 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>
* 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>
* Doc: Fix grammar in PyErr_ResourceWarning (GH-18879) (GH-18963)Miss Islington (bot)2020-03-131-1/+1
| | | | | (cherry picked from commit fdcd53fe1a8a7f052d7217c36b2597df06b6e016) 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>