Commit graph

10360 commits

Author SHA1 Message Date
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
Miss Skeleton (bot)
a358a0ad71
bpo-40484: Document compiler flags under AST module (GH-19885) (GH-22758)
Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com>
(cherry picked from commit 155938907c)

Co-authored-by: Batuhan Taskaya <batuhanosmantaskaya@gmail.com>

Co-authored-by: Batuhan Taskaya <batuhanosmantaskaya@gmail.com>
2020-10-19 20:29:38 +01:00
Miss Skeleton (bot)
2ee6ef98b4
bpo-41192: Fix some broken anchors for audit event entries (GH-21310) (GH-22767)
(cherry picked from commit ebc8c38287)

Co-authored-by: Saiyang Gou <gousaiyang@163.com>
2020-10-19 11:39:25 -04:00
Xie Yanbo
b30934e9af
[3.9] Fix incorrect parameter name (GH-22613) (GH-22628)
Automerge-Triggered-By: @Mariatta
(cherry picked from commit a42759351b)

Co-authored-by: Xie Yanbo <xieyanbo@gmail.com>
2020-10-15 22:55:28 +05:30
Miss Skeleton (bot)
78723b378b
Minor clarification (GH-22708) (GH-22709) 2020-10-15 00:09:33 -07:00
Miss Skeleton (bot)
270a2fbc55
Improve recipe readability (GH-22685) (GH-22686) 2020-10-13 17:19:05 -07:00
Miss Skeleton (bot)
5f0007f0f8
Add recipe for a version of random() with a larger population (GH-22664) (GH-22684) 2020-10-13 12:38:13 -07:00
Miss Skeleton (bot)
15ef19f7d7
Fix typo in "Context manager types" section in typing.rst (GH-22676)
Fix typo in the "Context manager types" section in `typing.rst`.

Automerge-Triggered-By: @gvanrossum
(cherry picked from commit ba06a70c82)

Co-authored-by: Saiyang Gou <gousaiyang@163.com>
2020-10-12 16:55:24 -07:00
Miss Skeleton (bot)
372a9e2135
Fix typo (GH-22582)
/af/of/s

Automerge-Triggered-By: @Mariatta
(cherry picked from commit 8197a93208)

Co-authored-by: Gaurav Kamath <st0le@users.noreply.github.com>
2020-10-12 06:53:10 -07:00
Miss Skeleton (bot)
f1c70cf9e8
Fix typo in typing.rst (GH-22625)
(cherry picked from commit 0ff8a3b374)

Co-authored-by: abdo <abd.nh25@gmail.com>
2020-10-11 01:06:48 -07:00
Miss Skeleton (bot)
5b1fdcacfc
bpo-41376: Fix the documentation of site.getusersitepackages() (GH-21602)
`site.getusersitepackages()` returns the location of the user-specific site-packages directory
even when the user-specific site-packages is disabled.

```
$ python -s -m site
sys.path = [
    '/home/user/conda/lib/python37.zip',
    '/home/user/conda/lib/python3.7',
    '/home/user/conda/lib/python3.7/lib-dynload',
    '/home/user/conda/lib/python3.7/site-packages',
]
USER_BASE: '/home/user/.local' (exists)
USER_SITE: '/home/user/.local/lib/python3.7/site-packages' (doesn't exist)
ENABLE_USER_SITE: False
```

It was not practical to prevent the function from returning None if user-specific site-packages are disabled, since there are other uses of the function which are relying on this behaviour (e.g. `python -m site`).
(cherry picked from commit 35f041dd01)

Co-authored-by: Phil Elson <pelson.pub@gmail.com>
2020-10-08 00:00:28 -07:00
Miss Skeleton (bot)
d5719247ba
bpo-41892: Clarify that an example in the ElementTree docs explicitly avoids modifying an XML tree while iterating over it. (GH-22464) (GH-22554)
(cherry picked from commit 40db798692)

Co-authored-by: scoder <stefan_ml@behnel.de>

Co-authored-by: scoder <stefan_ml@behnel.de>
2020-10-04 19:56:56 -04:00
Miss Skeleton (bot)
faa8c6a8f1
bpo-41898: add caveat on root logger seeing all messages in assertLogs doc (GH-22526) (GH-22540)
(cherry picked from commit 1ed5443526)
2020-10-04 16:38:03 +01:00
Miss Skeleton (bot)
5f9a08d95f
[doc] Use list[int] instead of List[int] (etc.) in a few more places (GH-22524)
This changes a few occurrences left behind by GH-22340.

Automerge-Triggered-By: @gvanrossum
(cherry picked from commit 7f54e563dc)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-10-03 15:33:30 -07:00
Miss Skeleton (bot)
e89253756c
[doc] Fix link to abc.collections.Iterable (GH-22520)
Missed this occurrence before, sorry. Also changed "the PEP" to "PEP".

Automerge-Triggered-By: @gvanrossum
(cherry picked from commit 3fe6148937)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-10-03 09:13:14 -07:00
Miss Skeleton (bot)
ef7b937b8f
[3.9] bpo-40833: Clarify Path.rename doc-string regarding relative paths (GH-20554)
(cherry picked from commit f97e42ef4d)

Co-authored-by: Ram Rachum <ram@rachum.com>
2020-10-03 13:44:14 +03:00
Miss Skeleton (bot)
ebc8072c3d
[doc] Fix link to abc.collections.Iterable (GH-22502)
Automerge-Triggered-By: @gvanrossum
(cherry picked from commit d4b9edd505)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-10-02 16:36:51 -07:00
Miss Islington (bot)
8fc828ec4e
Fix grammar in secrets module documentation (GH-22467)
From `In particularly,` to `In particular,`
(cherry picked from commit 63298930fb)

Co-authored-by: Max Smolens <msmolens@users.noreply.github.com>
2020-09-30 15:49:52 -07:00
Miss Islington (bot)
bdf46bc7e1
[doc] Leverage the fact that the actual types can now be indexed for typing (GH-22340)
This shows users that they can use the actual types. Using deprecated types is confusing.

This also prefers colections.abc.Sized instead of the alias typing.Sized. I guess the aliases were created to make it convenient to import all collections related types from the same place.

This should be backported to 3.9.

Automerge-Triggered-By: @gvanrossum
(cherry picked from commit d9ab95ff1f)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-09-27 12:42:29 -07:00
Miss Islington (bot)
8b2595f68a
bpo-41858: Clarify line in optparse doc (GH-22407)
The existing line is easily read as being incomplete.
(cherry picked from commit 00eb063b66)

Co-authored-by: Emmanuel Arias <eamanu@yaerobi.com>
2020-09-26 21:03:56 -07:00
Miss Islington (bot)
64362c2e43
bpo-37062: Enum: add extended AutoNumber example (GH-22349) (GH-22370)
(cherry picked from commit 62e40d8450)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2020-09-22 20:58:32 -07:00
Miss Islington (bot)
f27a1577d3
bpo-35764: Rewrite the IDLE Calltips doc section (GH-22363) 2020-09-22 14:35:38 -04:00
Miss Islington (bot)
c053402927
bpo-41762: Fix usage of productionlist markup in the doc (GH-22281)
Use an unique identifier for the different grammars documented using
the Sphinx productionlist markup.

productionlist markups of the same grammar, like "expressions" or
"compound statements", use the same identifier "python-grammar".
(cherry picked from commit 8af239eacf)

Co-authored-by: Victor Stinner <vstinner@python.org>
2020-09-18 00:27:21 -07:00
Serhiy Storchaka
6d893bab77
[3.9] Remove duplicated words words (GH-22298). (GH-22299)
(cherry picked from commit 27201cddf3)
2020-09-18 10:13:57 +03:00
Serhiy Storchaka
234ae8fe1b
[3.9] Remove duplicated words words (GH-20413). (GH-22296)
(cherry picked from commit 1c5d1d7304)
2020-09-18 09:36:14 +03:00
Miss Islington (bot)
0374883734
Improve the description of difflib in the documentation (GH-22253) (#22261)
From "can produce difference information in various formats ..."
to " can produce information about file differences in various formats ..."

Automerge-Triggered-By: @Mariatta
(cherry picked from commit 5531269f69)

Co-authored-by: Mandeep <mandeep052@gmail.com>
2020-09-15 12:45:05 -07:00