Commit graph

10385 commits

Author SHA1 Message Date
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
Miss Islington (bot)
aef482f7cf
Fix bz2 examples markup (GH-23580)
(cherry picked from commit 80a429eae9)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-12-01 02:04:23 -08:00
Julien Palard
7e80c0f40e
[3.9] [doc] Fix smtplib and xml.dom.minidom mark-up (GH-22769) (GH-23380) 2020-12-01 08:58:36 +01:00
Miss Islington (bot)
aab9390334
bpo-42501: Revise the usage note for Enums with the choices (GH-23563) (GH-23573) 2020-11-30 13:21:08 -08:00
Miss Islington (bot)
a83119d7be
bpo-42450: Minor updates to the itertools recipes (GH-23555) (GH-23562) 2020-11-29 11:14:10 -08:00
Miss Islington (bot)
cf47b3969e
bpo-39096: Improve description of 'e', 'f' and 'g' presentation types (GH-23537) (GH-23550)
* Improve description of 'e', 'f' and 'g' presentation types

* Drop the 'E' from Scientific 'E' notation; remove >= 0 qualifications

* Fix false statement that the alternate form is valid for Decimal

* Nitpick: remove the Harvard/Oxford comma

* Add note that the decimal point is also removed if no digits follow it, except in alternate form
(cherry picked from commit c642374b3e)

Co-authored-by: Mark Dickinson <mdickinson@enthought.com>

Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
2020-11-29 09:58:01 +00:00
Miss Islington (bot)
cfb2f79634
Fix dis markup (GH-23524)
(cherry picked from commit fa840cc81d)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-11-28 14:06:05 -08:00
Miss Islington (bot)
5d54dfadcf
Fix multiprocessing markup (GH-23525)
(cherry picked from commit 4b44472966)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-11-28 14:05:37 -08:00
Miss Islington (bot)
b6416052f7
Typo (GH-23482) (#23483)
(cherry picked from commit 989af25616)

Co-authored-by: Jesús Cea <jcea@jcea.es>

Co-authored-by: Jesús Cea <jcea@jcea.es>
2020-11-24 01:11:13 +01:00
Miss Islington (bot)
41d1ebb33e
Doc: fix typo in typing.Type docs (GH-23460)
(cherry picked from commit 5ef53a88f3)

Co-authored-by: John Belmonte <john@neggie.net>
2020-11-22 07:16:48 -08:00
Miss Islington (bot)
4f87126969
bpo-42391: Clarify documentation of TestCase.assertIs (GH-23348)
Removing 'evaluate' makes it more consistent with other assertX entries.
(cherry picked from commit bd8c22e1fa)

Co-authored-by: Ram Rachum <ram@rachum.com>
2020-11-21 22:24:21 -08:00
Miss Islington (bot)
89d74d0acd
Clarify that Set._from_iterable is not required to be a classmethod. (GH-23272) (GH-23450) 2020-11-21 12:20:26 -08:00
Miss Islington (bot)
3b5b1c82a3
Fix wrong availability for signal.SIGCHLD (GH-23285) (#23425)
I believe this is a mistake. SIGCHLD is only available on Unix systems, not Windows.
(cherry picked from commit 4c24b08cd3)

Co-authored-by: Zhang Maiyun <myzhang1029@hotmail.com>

Co-authored-by: Zhang Maiyun <myzhang1029@hotmail.com>
2020-11-21 13:22:46 +02:00
Miss Islington (bot)
c963da269d
bpo-42407: Use possessive appostrophe in multiprocessing doc (GH-23400)
(cherry picked from commit 6edf06b24a)

Co-authored-by: ArioA <ArioA@users.noreply.github.com>
2020-11-20 19:01:05 -08:00
Miss Islington (bot)
f552f4b2d6
bpo-42360: Add advice to help avoid pickling issues. (GH-23305) (GH-23429) 2020-11-20 13:19:49 -08:00
Miss Islington (bot)
1051ca4d97
bpo-42345: Add whatsnew and versionchanged for typing.Literal in 3.9 (GH-23386)
* Whatsnew entry in 3.9 same as the one in 3.10.
* versionchanged for typing.Literal docs

Needs backport to 3.9.
(cherry picked from commit e1dc0db8c7)

Co-authored-by: kj <28750310+Fidget-Spinner@users.noreply.github.com>
2020-11-19 09:59:10 -08:00
Miss Islington (bot)
2acd9d0c6c
bpo-42345: Fix hash implementation of typing.Literal (GH-23383)
Fix hash implementation of `typing.Literal`.

Update docs regarding `typing.Litaral` caching.

Base implementation was done in PR GH-23294.
(cherry picked from commit 1b54077ff6)

Co-authored-by: Yurii Karabas <1998uriyyo@gmail.com>
2020-11-19 08:51:01 -08:00
Miss Islington (bot)
f9fa920c30
[3.9] bpo-38320: Clarify that expectedFailure is satisfied by either failure or error of the test. (GH-22740) (GH-22783)
(cherry picked from commit fa8748271a)


Co-authored-by: Irit Katriel <iritkatriel@yahoo.com>
2020-11-18 14:37:37 -08:00
Miss Islington (bot)
7c4d8fa82a
bpo-42153 Fix link to IMAP documents in imaplib.rst (GH-23297)
The University of Washington stopped hosting the IMAP documents. Link to a rescued copy on GitHub.
(cherry picked from commit aa01011003)

Co-authored-by: Yash Shete <universeyash4@gmail.com>
2020-11-15 21:27:03 -08:00
Miss Islington (bot)
2369759a47
bpo-42317: Improve docs of typing.get_args concerning Union (GH-23254)
(cherry picked from commit c3b9592244)

Co-authored-by: Dominik1123 <15989985+Dominik1123@users.noreply.github.com>
2020-11-15 17:52:22 -08:00
Miss Islington (bot)
2837241f22
fix typo in ThreadedChildWatcher docs (GH-23277)
(cherry picked from commit 8836574a0f)

Co-authored-by: Thomas Grainger <tagrain@gmail.com>
2020-11-14 04:24:21 -08:00
Miss Islington (bot)
4defeb0071
bpo-42344: Improve pseudo implementation for SimpleNamespace (GH-23264) (GH-23270)
(cherry picked from commit bbeb2d266d)

Co-authored-by: Jürgen Gmach <juergen.gmach@googlemail.com>

Co-authored-by: Jürgen Gmach <juergen.gmach@googlemail.com>
2020-11-13 13:19:05 -05:00
Miss Islington (bot)
bc77704783
[3.9] bpo-42086: Document AST operator nodes acts as a singleton (GH-22896) (GH-22897)
Automerge-Triggered-By: GH:gvanrossum
(cherry picked from commit b37c994e5a)


Co-authored-by: Batuhan Taskaya <batuhanosmantaskaya@gmail.com>
2020-11-13 01:05:41 -08:00
Miss Islington (bot)
2e5bd4f677
Minor wording change in concurrent.futures. (GH-23194)
Fixes a grammar problem by adding a missing "as", and clarifies the wording of the valid ranges for max_workers.
(cherry picked from commit fd6f6fa403)

Co-authored-by: Don Kirkby <donkirkby@users.noreply.github.com>
2020-11-08 01:45:45 -08:00
Miss Islington (bot)
6255296c50
Remove outdated reference to pywin32 from platform module (GH-22005)
(cherry picked from commit 7c01f1540f)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-11-06 11:22:00 -08:00
Miss Skeleton (bot)
6b7a90db36
bpo-42180: fix plural in arguments and control (GH-23015) (GH-23114)
https://bugs.python.org/issue42180
(cherry picked from commit b76a840021)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2020-11-03 01:08:38 +00:00
Miss Skeleton (bot)
ff852aabf2
bpo-42230: Improve asyncio documentation regarding accepting sets vs iterables (GH-23073)
People call wait() and as_completed() with various non-set iterables,
a list should be the most common but there are others as well[1].

Considering typeshed also documents wait()[2] and as_completed()[3]
as accepting arbitrary iterables I think it's a good idea to document
the status quo better.

[1] https://github.com/aio-libs/aiokafka/pull/672
[2] 620989bac5/stdlib/3/asyncio/tasks.pyiGH-L161
[3] 620989bac5/stdlib/3/asyncio/tasks.pyiGH-L40
(cherry picked from commit 3d86d090dc)

Co-authored-by: Jakub Stasiak <jakub@stasiak.at>
2020-11-02 03:19:45 -08:00
kj
dbaa07db67
[3.9] bpo-42198: Document __new__ for types.GenericAlias (GH-23039) (GH-23061)
(cherry picked from commit bcbf758476)
2020-10-31 08:05:36 -07:00
Miss Skeleton (bot)
a39068bf48
bpo-42198: Link to GenericAlias in typing and expressions (GH-23030)
Follow up to 7cdf30fff3 and 4173320920. This addresses the point "1. Update links in typing, subscription and union to point to GenericAlias." in the bpo for this PR.
(cherry picked from commit 9129af6050)

Co-authored-by: kj <28750310+Fidget-Spinner@users.noreply.github.com>
2020-10-29 21:23:33 -07:00
Miss Skeleton (bot)
b626d2218c
bpo-42061: Document __format__ for IP addresses (GH-23018)
Automerge-Triggered-By: GH:ericvsmith
(cherry picked from commit 3317466061)

Co-authored-by: Teugea Ioan-Teodor <teodor.teugea@gmail.com>
2020-10-29 15:38:12 -07:00
kj
577d7c4e62
[3.9] bpo-41805: Documentation for PEP 585 (GH-22615) (GH-23016)
Backport of #22615 to 3.9 since that couldn't be auto-merged due to conflicts.
2020-10-28 08:33:36 -07:00
Miss Skeleton (bot)
df4790c071
Add a link to buffer protocol in bytearray() doc (GH-22675)
(cherry picked from commit 0f25c231b3)

Co-authored-by: Antoine <43954001+awecx@users.noreply.github.com>
2020-10-25 22:59:46 -07:00
Miss Skeleton (bot)
af891a962b
bpo-39108: Document threading issues for random.gauss() (GH-22928) (GH-22972) 2020-10-25 08:48:38 -07:00
Miss Skeleton (bot)
2cccc29eaf
bpo-29981: Add examples and update index for set, dict, and generator comprehensions'(GH-20272)
Co-authored-by: Rémi Lapeyre <remi.lapeyre@henki.fr>
(cherry picked from commit 2d55aa9e37)

Co-authored-by: Florian Dahlitz <f2dahlitz@freenet.de>
2020-10-24 19:53:41 -07:00
Miss Skeleton (bot)
427cb0aa78
bpo-42127: Document effect of cached_property on key-sharing dictionaries (GH-22930) (GH-22955) 2020-10-24 19:00:14 -07:00
Miss Skeleton (bot)
69479ecfa8
[3.9] bpo-38486: Fix dead qmail links in the mailbox docs (GH-22239) (GH-22901)
(cherry picked from commit ec388cfb4e)


Co-authored-by: Zackery Spytz <zspytz@gmail.com>

Automerge-Triggered-By: GH:warsaw
2020-10-22 16:55:05 -07:00
Miss Skeleton (bot)
f22f874a66
bpo-25655: Improve Win DLL loading failures doc (GH-22372)
Add documentation to help diagnose CDLL dependent DLL loading errors
on windows for OSError with message:
"[WinError 126] The specified module could not be found"
This error is otherwise difficult to diagnose.
(cherry picked from commit b6f2fc9040)

Co-authored-by: Philippe Ombredanne <pombredanne@gmail.com>
2020-10-22 09:02:13 -07:00
Miss Skeleton (bot)
6e842bcdf8
bpo-35181: Correct importlib documentation for some module attributes (GH-15190)
@ericsnowcurrently This PR will change the following:

In the library documentation importlib.rst:

- `module.__package__` can be `module.__name__` for packages;
- `spec.parent` can be `spec.__name__` for packages;
- `spec.loader` is not `None` for namespaces packages.

In the language documentation import.rst:

- `spec.loader` is not `None` for namespace packages.

Automerge-Triggered-By: GH:warsaw
(cherry picked from commit 27f1bd8787)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2020-10-21 14:39:41 -07:00
Miss Skeleton (bot)
c3442fd8a7
bpo-41959: Fix grammar around class asyncio.MultiLoopChildWatcher text (GH-22580) (#22865)
While translating the following document to Spanish we found there is a grammar issue on the original documentation.
(cherry picked from commit caff2934f4)

Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>

Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
2020-10-21 23:34:29 +03:00
Miss Skeleton (bot)
19019eccde
bpo-41646: Mention path-like objects support in the docs for shutil.copy() (GH-22208)
(cherry picked from commit 8f2b991eef)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2020-10-21 14:16:42 +09:00
Miss Skeleton (bot)
46130f8538
bpo-41192: Add documentation of undocumented audit events (GH-22831)
(cherry picked from commit 3f7e990fd4)
2020-10-20 16:05:13 -04:00
Andrew Kuchling
b948d13ec0
[3.9] bpo-41192: Clarify the sys module's description of the auditing feature (GH-22821)
Co-authored-by: Éric Araujo <merwok@netwok.org>
(cherry picked from commit 0c37269be7)
2020-10-20 11:36:52 -04:00
Miss Skeleton (bot)
4aed781eb4
Doc: Add missing spaces after period for posix_spawn (GH-22730)
(cherry picked from commit 5b57fa6940)

Co-authored-by: Tomer Cohen <tomer@users.noreply.github.com>
2020-10-20 08:01:56 -07:00
Miss Skeleton (bot)
b249aeae89
bpo-39693: mention KeyError in tarfile extractfile documentation (GH-18639)
Co-authored-by: Andrey Darascheka <andrei.daraschenka@leverx.com>
(cherry picked from commit ec42789e6e)

Closes bpo-39693.
2020-10-20 10:31:03 -04:00
Miss Skeleton (bot)
335eb57823
[doc] Add link to Generic in typing (GH-22125)
(cherry picked from commit 5bfd60fc2b)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-10-19 16:08:19 -07:00
Miss Skeleton (bot)
9308173f88
bpo-40901: Describe what "interface name" means on Windows (GH-20694)
(cherry picked from commit f85658a098)

Co-authored-by: Jakub Stasiak <jakub@stasiak.at>
2020-10-19 15:49:55 -07:00
Miss Skeleton (bot)
6a9c1268ca
Document that test.support.bytecode_helper is new in 3.9 (GH-22618) (GH-22761)
(cherry picked from commit cf693e537d)

Co-authored-by: Saiyang Gou <gousaiyang@163.com>

Co-authored-by: Saiyang Gou <gousaiyang@163.com>
2020-10-19 19:44:06 -03:00
Miss Skeleton (bot)
b62ecc21b4
bpo-41217: Fix incorrect note in the asyncio.create_subprocess_shell() docs (GH-21360)
On Windows, the default asyncio event loop is ProactorEventLoop (as of 3.8).
(cherry picked from commit 4dfb190a33)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2020-10-19 15:30:39 -07:00