Commit graph

10432 commits

Author SHA1 Message Date
Miss Islington (bot)
374ee44933
bpo-43396: Normalise naming in sqlite3 doc examples (GH-24746)
(cherry picked from commit 40d1b831ec)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2021-03-04 19:11:40 +02:00
Miss Islington (bot)
ff6a021c25
Add an attribution to the Green Tree Snakes in the AST docs (GH-24727)
(cherry picked from commit 62e3b6370c)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2021-03-03 10:48:56 -08:00
Miss Islington (bot)
f836e5f219
Doc: Improve library/json document. (GH-24390)
(cherry picked from commit a347bc0b35)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2021-03-01 18:15:05 -08:00
Miss Islington (bot)
4f9eb3f3d3
Fix grammar in enum documentation. (GH-24689)
There is an extra `s` in the singular word `method`.
Reported in docs mailing list by Steven Nguyen.

Automerge-Triggered-By: GH:Mariatta
(cherry picked from commit f193874056)

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
2021-03-01 11:21:05 -08:00
Miss Islington (bot)
f82578ace1
bpo-43293: Doc: move note about GIL to top of threading module (GH-24622)
The note about the GIL was buried pretty deep in the threading documentation,
and this made it hard for first time users to discover why their attempts
at using threading to parallelizing their application did not work.

In this commit, the note is moved to the top of the module documention for
visibility.
(cherry picked from commit 32181be608)

Co-authored-by: Guanzhong Chen <quantum2048@gmail.com>
2021-02-24 11:01:33 -08:00
Miss Islington (bot)
e202f1e4db
bpo-43283: Add IDLE doc paragraph about print speed (GH-24615)
Printing to IDLE's Shell is often slower than printing to a system
terminal, but it can be made faster by pre-formatting a single
string before printing.
(cherry picked from commit 2827e8a177)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-02-23 17:03:37 -08:00
Miss Islington (bot)
30fe3ee6d3
bpo-23882: Doc: Clarify unittest discovery document (GH-21560)
Unittest discovery support namespace package as start
directory. But it doesn't find namespace package in
the start directory automatically.

Otherwise, unittest discovery search into unexpected
directories like `vendor/` or `node_modules/`.
(cherry picked from commit 5a4aa4c03e)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2021-02-21 22:37:18 -08:00
Miss Islington (bot)
693aeacf88
bpo-43283: Rearrange some IDLE doc paragraphs. (GH-24604)
In the Running User Code section, gather together paragraphs about two
processes and the sys.stdstream replacements, preparing to add another.
(cherry picked from commit 4cf7bb8e22)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-02-21 00:07:33 -08:00
Miss Islington (bot)
216cb1469f
Fix typo in dis module doc (GH-24509)
(cherry picked from commit 292f23186c)

Co-authored-by: Irit Katriel <iritkatriel@yahoo.com>
2021-02-19 20:46:34 -08:00
Pablo Galindo
9cc70bc220
[3.9] Minor improvements to the convolve() recipe (GH-24520) 2021-02-15 23:02:41 +00:00
Senthil Kumaran
c9f07813ab
[3.9] bpo-42967: only use '&' as a query string separator (GH-24297) (#24528)
(cherry picked from commit fcbe0cb04d)

* [3.9] bpo-42967: only use '&' as a query string separator (GH-24297)

bpo-42967: [security] Address a web cache-poisoning issue reported in urllib.parse.parse_qsl().

urllib.parse will only us "&" as query string separator by default instead of both ";" and "&" as allowed in earlier versions. An optional argument seperator with default value "&" is added to specify the separator.

Co-authored-by: Éric Araujo <merwok@netwok.org>
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
Co-authored-by: Adam Goldschmidt <adamgold7@gmail.com>
2021-02-15 10:03:31 -08:00
Miss Islington (bot)
242f6c9ffe
bpo-43200: Fix link to shutil.copy() in the shutil doc (GH-24505)
Co-authored-by: Zackery Spytz <zspytz@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
(cherry picked from commit 762fe7deed)
2021-02-13 00:20:24 -05:00
Ken Jin
917eca700a
bpo-41824: Add versionadded for typing.ForwardRef docs (#24224) (#24493) 2021-02-09 08:55:03 -08:00
Miss Islington (bot)
863eb7170b
bpo-16781: In 'exec' doc, add 'nonlocal' to 'yield' and 'return' (GH-2446)
These 3 statements cannot be used at module scope -- nor in exec with one namespace.
(cherry picked from commit 0ec57e25c9)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-02-07 09:14:16 -05:00
Miss Islington (bot)
926ca51be4
bpo-43059: Remove reference to legacy external sqlite3 repository (GH-24364)
(cherry picked from commit e603443642)

Co-authored-by: L <3177243+LukeLR@users.noreply.github.com>
2021-01-31 07:21:28 +02:00
Miss Islington (bot)
d34be1ed57
Fixing typos in turtle.rst (GH-24376)
Automerge-Triggered-By: GH:JulienPalard
(cherry picked from commit 6baaae589d)

Co-authored-by: Jules Lasne <jules.lasne@gmail.com>
2021-01-29 14:03:18 -08:00
Miss Islington (bot)
44cd24452a
Fixed typo in turtle.rst (GH-24371)
Found it while translating it to french 🤷

Automerge-Triggered-By: GH:JulienPalard
(cherry picked from commit 6372a4ceba)

Co-authored-by: Jules Lasne <jules.lasne@gmail.com>
2021-01-29 13:38:16 -08:00
Miss Islington (bot)
68102fb998
bpo-43008: Make IDLE respect sys.excepthook (GH-24302)
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
(cherry picked from commit 7a34380ad7)

Co-authored-by: Ken <kenny2minecraft@gmail.com>
2021-01-26 16:24:14 -08:00
Miss Islington (bot)
98e1f5c778
bpo-40304: Correct type(name, bases, dict) doc (GH-19553)
Co-authored-by: Éric Araujo <merwok@netwok.org>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com>
(cherry picked from commit 644d52818a)

Co-authored-by: Борис Верховский <boris.verk@gmail.com>
2021-01-21 22:09:50 -08:00
Yair Frid
8c3914aef4
[3.9] bpo-42811: Update importlib.utils.resolve_name() docs to use __spec__.parent (GH-24100) (GH-24149)
This is a backport of 
https://github.com/python/cpython/pull/24100

Automerge-Triggered-By: GH:brettcannon
2021-01-07 10:06:13 -08:00
Vladimir
49c150f1f1
bpo-38413: Remove outdated section about multithreading in sqlite3 (GH-23159)
(cherry picked from commit f9949f82e1)
2021-01-06 22:57:24 +02:00
Miss Islington (bot)
a3ca6747f5
bpo-14014: Clarify StreamWriter.reset() documentation (GH-13716)
(cherry picked from commit 1a9f51ed12)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
2021-01-06 04:27:30 +02:00
Julien Palard
e6d0107e13
Revert "[3.9] [doc] Fix erroneous backslashes in signatures and names (GH-23658)" (GH-24092)
This partially reverts commit
e89993cff4, which was removing
backslashes in documentations compiled with Sphinx < 3, used for
Python 3.8 and 3.9 docs.
2021-01-04 17:19:27 +01:00
Serhiy Storchaka
b0ee2b492d
[3.9] bpo-42681: Fix range checks for color and pair numbers in curses (GH-23874). (GH-24077)
(cherry picked from commit 1470edd613)
2021-01-04 00:55:23 +02:00
Miss Islington (bot)
8333d421c0
bpo-42781: Document the mechanics of cached_property from a user viewpoint (GH-24031) (#24035) 2020-12-31 17:36:14 -08:00
Miss Islington (bot)
55fadffb0b
Fixes a typo in importlib.metadata. (GH-23921) (#24029)
Signed-off-by: Tao He <sighingnow@gmail.com>
(cherry picked from commit 3631d6deab)

Co-authored-by: Tao He <sighingnow@gmail.com>

Co-authored-by: Tao He <sighingnow@gmail.com>
2020-12-31 12:27:17 -08:00
Andre Delfino
7a7f3e0d6a
[3.9] bpo-41224: Add versionadded for Symbol.is_annotated (GH-23861). (GH-24017)
(cherry picked from commit 2edfc86f69)
2020-12-31 15:10:10 +02:00
Miss Islington (bot)
cc7f745e80
bpo-42700: Swap descriptions in pyexpat.errors (GH-23876)
The descriptions of the `codes` and `messages` dictionaries in
`xml.parsers.expat.errors` were swapped, and this commit swaps them
back. For example, `codes` maps string descriptions of errors to numeric
error codes, not the other way around.
(cherry picked from commit 84402eb110)

Co-authored-by: Michael Wayne Goodman <goodman.m.w@gmail.com>
2020-12-29 04:55:33 -08:00
Miss Islington (bot)
1ceb097cec
[doc] Fix missing commas in signatures (GH-23693)
* Fix star in signatures

* Fix comma in signatures
(cherry picked from commit 60eccd0956)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-12-29 04:28:58 -08:00
Miss Islington (bot)
0b43778b3c
bpo-42770: Fix a typo in the email.headerregistry docs (GH-23982)
Automerge-Triggered-By: GH:zware
(cherry picked from commit c56988b88f)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2020-12-28 20:37:20 -08:00
Miss Islington (bot)
9f6a37cc07
bpo-42755: Fix sqlite3.Connection.backup docs (GH-23965)
The `pages` argument default value now reflects the implementation.
(cherry picked from commit abba83b4b9)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2020-12-27 14:56:41 -08:00
Miss Islington (bot)
ed48e9e286
Add convolve() to the itertools recipes (GH-23928) (GH-23949) 2020-12-25 20:23:35 -08:00
Miss Islington (bot)
7acfe41257
bpo-42388: Fix subprocess.check_output input=None when text=True (GH-23467)
When the modern text= spelling of the universal_newlines= parameter was added
for Python 3.7, check_output's special case around input=None was overlooked.
So it behaved differently with universal_newlines=True vs text=True.  This
reconciles the behavior to be consistent and adds a test to guarantee it.

Also clarifies the existing check_output documentation.

Co-authored-by: Alexey Izbyshev <izbyshev@ispras.ru>
(cherry picked from commit 64abf37344)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2020-12-24 21:18:37 -08:00
Miss Islington (bot)
1e1bacf9e6
BPO-42703: Fix incorrect documentation links for asyncio.Event (GH-23881)
(cherry picked from commit d90ff37681)

Co-authored-by: Matt Fowler <matt.fow@gmail.com>
2020-12-23 03:13:51 -08:00
Miss Islington (bot)
4ec2149708
bpo-29030: Document interaction between *choices* and *metavar*. (GH-23884) (GH-23894) 2020-12-22 10:19:24 -08:00
Andre Delfino
7c48859eeb
[3.9] [doc] Fix a few margins due to bad markup (GH-23619). (GH-23859)
(cherry picked from commit 96a09df644)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-12-21 18:53:50 -08:00
Andre Delfino
e89993cff4
[3.9] [doc] Fix erroneous backslashes in signatures and names (GH-23658) (GH-23827)
The issue being resolved is shown in the 3.10 docs (if you select docs for older versions you won't see a visual glitch).

The newer sphinx version that produces the 3.10 docs doesn't treat the backslash to escape things in some situations it previously did..
(cherry picked from commit dcc997cd28)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-12-21 18:52:19 -08:00
Miss Islington (bot)
40b4c405f9
bpo-42572: Improve argparse docs for the type parameter. (GH-23849) (GH-23869) 2020-12-20 10:51:20 -08:00
Miss Islington (bot)
a34ab8188e
bpo-41724: Explain when the conversion is not possible with detect_types enabled (GH-23855) (GH-23862)
* Explain when the conversion is not possible with detect_types enabled
(cherry picked from commit 09a36cdfb7)

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

Co-authored-by: sblondon <sblondon@users.noreply.github.com>
2020-12-19 19:02:25 -05:00
kj
597ebc8cf6
[3.9] bpo-42675: Document collections.abc.Callable changes (GH-23839) (#23852) 2020-12-19 14:32:06 -08:00
Miss Islington (bot)
d458d8dab0
bpo-42559: Not that getrandbits() is non-negative. (GH-23843) (GH-23851) 2020-12-18 19:10:06 -08:00
Miss Islington (bot)
782665885c
bpo-34805: Guarantee that __subclasses__() is in definition order. (GH-23844) (GH-23850) 2020-12-18 17:17:32 -08:00
Miss Islington (bot)
eef33e6d49
bpo-42670: Fix a missing word in the itertools.product() docs (GH-23823) (GH-23824) 2020-12-18 16:55:52 -08:00
Miss Islington (bot)
4b412e830d
bpo-36769: Document that fnmatch.filter supports any kind of iterable (GH-13039)
(cherry picked from commit e8d2264210)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-12-18 11:34:27 -08:00
Miss Islington (bot)
14619924c3
bpo-17140: Document multiprocessing's ThreadPool (GH-23812)
Up until now, the `multiprocessing.pool.ThreadPool` class has gone
undocumented, despite being a public class in multiprocessing that is
included in `multiprocessing.pool.__all__`.
(cherry picked from commit 84ebcf271a)

Co-authored-by: Matt Wozniski <mwozniski@bloomberg.net>
2020-12-18 05:27:02 -08:00
Miss Islington (bot)
b812e236df
bpo-39096: Format specification documentation fixes for numeric types (GH-23575)
(cherry picked from commit 886b2e5c7a)

Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
2020-12-18 01:49:19 -08:00
Miss Islington (bot)
2fba8445a4
Fix indentation for get_stats_profile() docs (GH-23618)
The existing method is indented one too many times which
makes it look like a sub-method of print_callees().
(cherry picked from commit a6ba2b9015)

Co-authored-by: Matthew Suozzo <msuozzo@google.com>
2020-12-17 01:18:39 +02:00
Miss Islington (bot)
aba12b67c1
[3.9] bpo-42517: [Enum] deprecate private name members (GH-23722) (GH-23748)
private names will raise a DeprecationWarning; in 3.10 they will become normal attributes
2020-12-14 15:56:58 -08:00
Andre Delfino
c1a3f9a9cb
[3.9] [doc] Link to issue regarding logging.disable level param default value GH-23732
(cherry picked from commit 2a35137328)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-12-10 06:20:04 -08:00
Miss Islington (bot)
facca72eae
bpo-38843: Document behavior of default when the attribute is already set (GH-23653) (#23668)
(cherry picked from commit 752cdf21eb)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2020-12-06 21:17:09 -08:00