Commit Graph

22846 Commits

Author SHA1 Message Date
Miss Islington (bot) eb5ce324f7
bpo-38872: Document exec symbol for codeop.compile_command (GH-20047) (GH-20098)
* Document exec symbol for codeop.compile_command

* Remove extra statements

Co-authored-by: nanjekyejoannah <joannah.nanjekye@ibm.com>
(cherry picked from commit 7ba1f75f3f)

Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>

Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
2020-05-14 22:38:17 -03:00
Miss Islington (bot) 546f643487
Make the first dataclass example more useful (GH-19994) (GH-19997)
(cherry picked from commit 2effef7453)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2020-05-08 07:52:10 -04:00
Miss Islington (bot) 9609460ce0
Remove outdated and confusing advice about setting maxsize (GH-19889) (GH-19890) 2020-05-03 17:16:36 -07:00
Miss Islington (bot) 108e45524d
Fix missing space in docs(GH-19866) (GH-19872) 2020-05-02 17:05:49 -07:00
Miss Islington (bot) 399b9a4a62
bpo-40419: timeit CLI docs now mention 1,2,5,10,... trials instead of powers of 10 (GH-19752)
(cherry picked from commit 766352320f)

Co-authored-by: Sander <svr003@gmail.com>
2020-05-02 09:29:51 -07:00
Antoine Pitrou e05828055e
[3.8] bpo-39435: Fix docs for pickle.loads (GH-18160) (GH-19843)
(cherry picked from commit 289842a)

Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com>

Automerge-Triggered-By: @pitrou
2020-05-01 12:54:44 -07:00
Miss Islington (bot) c9d7d32b6d
bpo-39691: Clarify io.open_code behavior (GH-19824)
(cherry picked from commit 831d58d786)

Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com>
2020-05-01 11:04:25 -07:00
Pablo Galindo 71e6122b44
bpo-39562: Correctly updated the version section in the what's new document (GH-19838) 2020-05-01 16:36:51 +01:00
Pablo Galindo 5055c274c6
[3.8] bpo-39562: Prevent collision of future and compiler flags (GH-19230) (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 4454057269)

Co-authored-by: Batuhan Taşkaya <batuhanosmantaskaya@gmail.com>
2020-05-01 07:18:27 -07:00
Miss Islington (bot) 9412f4d1ad
bpo-40348: Fix typos in the programming FAQ (GH-19729)
(cherry picked from commit caf1aadf3d)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2020-04-26 20:29:30 -07:00
Zachary Ware ca5649c4c1
[3.8] bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros (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>
2020-04-26 21:45:05 -05:00
Miss Islington (bot) 179f22c3b7
bpo-40387: Improve queue join() example. (GH-19724) (GH-19726) 2020-04-26 18:23:14 -07:00
Miss Islington (bot) 882a7f44da
bpo-40279: Add some error-handling to the module initialisation docs example (GH-19705) (GH-19710)
(cherry picked from commit d4f3923d59)

Co-authored-by: Cajetan Rodrigues <caje731@gmail.com>
2020-04-25 07:45:48 +02:00
Miss Islington (bot) 22a4849cd8
Minor modernization and readability improvement to the tokenizer example (GH-19558) (GH-19661)
(cherry picked from commit bf1a81258c)
2020-04-22 13:50:32 -07:00
Miss Islington (bot) 7d65c045de
Small improvements to the recipes and examples. (GH-19635) (GH-19638)
* 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 d3a8d616fa)
2020-04-21 16:18:49 -07:00
Miss Islington (bot) 8c07343976
bpo-39285: Clarify example for PurePath.match (GH-19458)
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 c12375aa0b)

Co-authored-by: Tim Lo <timlo@users.noreply.github.com>
2020-04-19 03:03:35 -07:00
Miss Islington (bot) 020f2aaaea
bpo-27635: Fix pickle documentation about `__new__` not being called. (GH-19269)
Automerge-Triggered-By: @pitrou
(cherry picked from commit 482259d0dc)

Co-authored-by: Furkan Önder <furkantahaonder@gmail.com>
2020-04-18 11:14:55 -07:00
Miss Islington (bot) 08b640f572
Fix parameter names in assertIn() docs (GH-18829)
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 a388bbd3f1)

Co-authored-by: Christoph Zwerschke <cito@online.de>
2020-04-16 19:06:11 -07:00
Miss Islington (bot) 3e72de9e08
[3.8] bpo-39667: Sync zipp 3.0 (GH-18540) (GH-18701)
* 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 0aeab5c438)

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>
2020-04-15 14:45:25 -04:00
Miss Islington (bot) ee691b078b
[3.8] Improved documentation for `BUILD_CONST_KEY_MAP` (GH-19454) (GH-19495)
(cherry picked from commit 85dd6bb1f6)


Co-authored-by: laike9m <laike9m@users.noreply.github.com>

Automerge-Triggered-By: @zhangyangyu
2020-04-12 20:01:53 -07:00
Miss Islington (bot) ceba0648d7
bpo-38501: Add a warning section to multiprocessing.Pool docs about resource managing (GH-19466)
(cherry picked from commit 7ec43a7309)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2020-04-10 19:11:17 -07:00
Miss Islington (bot) 1bf7dee8d3
bpo-40197: Better describe the benchmark results table (GH-19386)
(cherry picked from commit c63629e7c0)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2020-04-10 13:00:15 -07:00
Victor Stinner 37a257c0ae
bpo-40204: Pin Sphinx version to 1.8.2 in Doc/Makefile (GH-19442) 2020-04-09 00:36:13 +02:00
Miss Islington (bot) f7b0259d0d
Fix misinformation about NaN != NaN comparison (GH-19357) (GH-19383)
(cherry picked from commit 810f68f128)

Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
2020-04-05 10:56:37 +01:00
Serhiy Storchaka 0d1d7c8bae
bpo-36320: Use the deprecated-removed directive for _field_types (GH-19370) 2020-04-05 00:43:07 +03:00
Miss Islington (bot) e6783981df
bpo-40131: Fix source and target order in zipapp example (GH-19290) (GH-19339)
(cherry picked from commit bd6a4c3d72)


Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2020-04-03 22:43:58 +05:30
Miss Islington (bot) 77c623ba3d
bpo-40122: Updated documentation for dis.findlabels() (GH-19274)
(cherry picked from commit b74468e233)

Co-authored-by: laike9m <laike9m@users.noreply.github.com>
2020-04-03 01:07:16 -07:00
Miss Islington (bot) b7345c24a4
bpo-38972: Link to instructions to change PowerShell execution policy (GH-19131)
(cherry picked from commit 45217af29c)

Co-authored-by: Derek Keeler <d3r3kk@users.noreply.github.com>
2020-04-02 12:19:41 -07:00
Miss Islington (bot) 267afc2ab2
bpo-40094: Enhance os.WIFEXITED documentation (GH-19244) (GH-19277)
(cherry picked from commit 7c72383f95)

Co-authored-by: Victor Stinner <vstinner@python.org>
2020-04-02 01:26:55 +02:00
Victor Stinner 40e1b04e38
Document most common signals (GH-19245) (GH-19257)
Document individual signals (only the most common signals):
description, default action, availability.

(cherry picked from commit 400e1dbcad)
2020-03-31 19:44:28 +02:00
Miss Islington (bot) 6c9a2a831e
fix comma location in various places (GH-19233)
(cherry picked from commit c49016e67c)

Co-authored-by: Mathieu Dupuy <deronnax@users.noreply.github.com>
2020-03-30 14:34:31 -07:00
Miss Islington (bot) bb852266b7
bpo-40045: Make "dunder" method documentation easier to locate (GH-19153) (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 5f9c131c09)

Co-authored-by: Javad Mokhtari <javadmokhtari@outlook.com>

Co-authored-by: Javad Mokhtari <javadmokhtari@outlook.com>
2020-03-27 16:15:11 -03:00
Miss Islington (bot) 9c5c497ac1
bpo-38237: Use divmod for positional arguments whatsnew example (GH-19171)
(cherry picked from commit 5a58c5280b)

Co-authored-by: Ammar Askar <ammar@ammaraskar.com>
2020-03-27 09:45:05 -07:00
Miss Islington (bot) 8dad09a224
bpo-19698: Document when importlib.machinery.FrozenImporter gained spec-related methods (GH-19158) (#19164)
(cherry picked from commit 302e5a8f79)

Co-authored-by: Brett Cannon <54418+brettcannon@users.noreply.github.com>

Co-authored-by: Brett Cannon <54418+brettcannon@users.noreply.github.com>
2020-03-26 10:15:05 -07:00
Miss Islington (bot) 96686c761d
bpo-39879: Update datamodel docs to include dict ordering (GH-19006)
Co-authored-by: furkanonder <furkantahaonder@gmail.com>
(cherry picked from commit 59c644eaa7)

Co-authored-by: Lahfa Samy <lahfa121999@gmail.com>
2020-03-26 08:00:46 -07:00
Miss Islington (bot) 2227c1a4ca
bpo-40013: Clarify documentation of restval in csv.DictReader (GH-19099) (GH-19141)
(cherry picked from commit 4b3252cb76)


Co-authored-by: Juhana Jauhiainen <juhana.jauhiainen@gmail.com>
2020-03-25 12:30:53 +05:30
Miss Islington (bot) 8cd48b60fd
Clarify a guarantee of the logging module. (GH-19132)
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 9b8e74ca77)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2020-03-24 09:54:40 -07:00
Miss Islington (bot) 687f5921a4
bpo-39652: Truncate the column name after '[' only if PARSE_COLNAMES is set. (GH-18942)
(cherry picked from commit b146568dfc)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2020-03-21 07:32:25 -07:00
Miss Islington (bot) 29723368e7
bpo-39797 Changes to socketserver.BaseServer's shutdown() method. (GH-18929)
Automerge-Triggered-By: @ned-deily
(cherry picked from commit 2de7ac9798)

Co-authored-by: amaajemyfren <32741226+amaajemyfren@users.noreply.github.com>
2020-03-20 01:08:52 -07:00
Miss Islington (bot) 2477aed12d
Fix "versionchanged" for pow named arguments (GH-19042) (GH-19079)
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 c691f20952)

Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
2020-03-19 18:35:02 +00:00
Miss Islington (bot) da1fe768e5
bpo-39973: Fix the docs for PyObject_GenericSetDict() (GH-19026)
PyObject_GenericSetDict() takes three arguments, not two.
(cherry picked from commit a45b695b9f)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2020-03-17 01:25:34 -07:00
Miss Islington (bot) 4abe77c725
bpo-39869: Fix typo in 'Instance objects' section. (GH-18889)
(cherry picked from commit e5e56328af)

Co-authored-by: Antoine <43954001+awecx@users.noreply.github.com>
2020-03-14 15:13:18 -07:00
Miss Islington (bot) 9c63cd8c63
Link to list of keywords in the laguage reference (GH-18024)
(cherry picked from commit 33238ec2af)

Co-authored-by: Борис Верховский <boris.verk@gmail.com>
2020-03-14 12:14:57 -07:00
Miss Islington (bot) a927e91186
bpo-39677: dis: rename the operand of MAKE_FUNCTION from `argc` to `flags` for 3.6+ (GC-18550)
(cherry picked from commit 6672c16b1d)

Co-authored-by: Taine Zhao <twshere@outlook.com>
2020-03-14 07:45:23 -07:00
Karthikeyan Singaravelan d3af92ecc2
[3.8] Doc: Fix grammar in PyErr_ResourceWarning (GH-18879) (GH-18976)
(cherry picked from commit fdcd53f)

Co-authored-by: Daniel Hahler <git@thequod.de>
2020-03-13 21:02:38 +05:30
Miss Islington (bot) 99ef1ac9a7
Fix syntax error in an example in the ast documentation and sync docstrings (GH-18946)
(cherry picked from commit c00c86b904)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2020-03-11 18:06:53 -07:00
Miss Islington (bot) 6ce36ed4a7
Fix download.html (GH-18902)
`<tt>` is not allowed.

Co-authored-by: Kyle Stanley <aeros167@gmail.com>
(cherry picked from commit 39c34933fc)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2020-03-10 21:40:04 -07:00
Miss Islington (bot) b26ccfe3f9
tracemalloc: 'pretty top' example no longer changes the filename (GH-18903)
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 d06eec218e)

Co-authored-by: Adam Johnson <me@adamj.eu>
2020-03-10 11:26:20 -07:00
Miss Islington (bot) a5e821c726
bpo-39852: IDLE 'Go to line' deletes selection, updates status (GH-18801)
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 2522db11df)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2020-03-08 11:49:44 -07:00
Miss Islington (bot) 765117dc16
fix typo: add space (GH-18853)
Fix typo in cmdline.rst
Add space between the `-m` option and the module name (`timeit`).
(cherry picked from commit c580981ba0)

Co-authored-by: Julin S <48789920+ju-sh@users.noreply.github.com>
2020-03-08 10:58:19 -07:00