Commit Graph

10100 Commits

Author SHA1 Message Date
Miss Islington (bot) 04232de229
Fix bz2 examples markup (GH-23580)
(cherry picked from commit 80a429eae9)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-12-01 01:51:12 -08:00
Miss Islington (bot) c3009a5818
bpo-39096: Improve description of 'e', 'f' and 'g' presentation types (GH-23537) (GH-23551)
* 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:35 +00:00
Miss Islington (bot) 5be629d513
Fix multiprocessing markup (GH-23525)
(cherry picked from commit 4b44472966)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-11-28 13:52:10 -08:00
Miss Islington (bot) 734d6d9dfe
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:12:20 -08:00
Miss Islington (bot) 2528a7db1c
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:10:24 -08:00
Miss Islington (bot) 7e9bf4ec91
Fix wrong availability for signal.SIGCHLD (GH-23285) (#23426)
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:08 +02:00
Miss Islington (bot) 0762e09eb1
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 18:47:17 -08:00
Miss Islington (bot) 5f463e501b
[3.8] bpo-38320: Clarify that expectedFailure is satisfied by either failure or error of the test. (GH-22740) (GH-22782)
(cherry picked from commit fa8748271a)


Co-authored-by: Irit Katriel <iritkatriel@yahoo.com>
2020-11-18 14:39:42 -08:00
Miss Islington (bot) 545dcb178e
[3.8] Remove outdated reference to pywin32 from platform module (GH-22005) (GH-23184)
(cherry picked from commit 7c01f1540f)


Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-11-16 23:34:24 -08:00
Miss Islington (bot) 85a8a19134
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:12:34 -08:00
Miss Islington (bot) 71827351c4
fix typo in ThreadedChildWatcher docs (GH-23277)
(cherry picked from commit 8836574a0f)

Co-authored-by: Thomas Grainger <tagrain@gmail.com>
2020-11-14 04:11:23 -08:00
Miss Islington (bot) cb2b2035ca
bpo-42344: Improve pseudo implementation for SimpleNamespace (GH-23264) (GH-23269)
(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:18:35 -05:00
Miss Islington (bot) a7de7ffe32
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:25 -08:00
Jakub Stasiak ad37c66adc
[3.8] bpo-42230: Improve asyncio documentation regarding accepting sets vs iterables (GH-23073) (GH-23105)
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 13:36:38 +02:00
Miss Skeleton (bot) 77a9ef1bba
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:35:55 -07:00
Miss Skeleton (bot) 60bef61f71
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:18 -07:00
Miss Skeleton (bot) cd894b1094
[3.8] bpo-38486: Fix dead qmail links in the mailbox docs (GH-22239) (GH-22902)
(cherry picked from commit ec388cfb4e)


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

Automerge-Triggered-By: GH:warsaw
2020-10-22 16:42:01 -07:00
Miss Skeleton (bot) 5d8bc65ba5
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 08:48:51 -07:00
Miss Skeleton (bot) 916ac95201
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:27:10 -07:00
Miss Skeleton (bot) ba666747af
[3.8] bpo-41959: Fix grammar around class asyncio.MultiLoopChildWatcher text (GH-22580) (GH-22866)
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>
2020-10-21 13:33:12 -07:00
Miss Skeleton (bot) 6443a8ccc8
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:21 +09:00
Miss Skeleton (bot) 058affc09f
bpo-41192: Add documentation of undocumented audit events (GH-22832)
(cherry picked from commit 3f7e990fd4)
2020-10-20 16:05:55 -04:00
Miss Skeleton (bot) a797fd74fe
bpo-41192: Clarify the sys module's description of the auditing feature (GH-22820)
Co-authored-by: Éric Araujo <merwok@netwok.org>
(cherry picked from commit 0c37269be7)

Co-authored-by: Andrew Kuchling <amk@amk.ca>

Co-authored-by: Andrew Kuchling <amk@amk.ca>
2020-10-20 11:15:02 -04:00
Miss Skeleton (bot) ccfc05723e
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:38 -07:00
Miss Skeleton (bot) 609a38a36f
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:39:50 -07:00
Miss Skeleton (bot) dc785db64d
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:19:00 -07:00
Miss Skeleton (bot) ec18c468b8
bpo-41192: Fix some broken anchors for audit event entries (GH-21310) (GH-22770)
(cherry picked from commit ebc8c38287)

Co-authored-by: Saiyang Gou <gousaiyang@163.com>
2020-10-19 14:52:27 -04:00
Jason R. Coombs 967fddae2f
[3.8] bpo-41855: Fix duplicate results in FastPath.zip_children() (#22404)
* bpo-41855: Backport fixes from importlib_metadata 1.5.2.

* Add blurb.

* Add anchor for finders and loaders
2020-10-15 17:05:12 -04:00
Miss Skeleton (bot) 1006f63a8b
bpo-41376: Fix the documentation of `site.getusersitepackages()` (GH-21602) (GH-22592)
`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>

Co-authored-by: Phil Elson <pelson.pub@gmail.com>
2020-10-11 19:21:31 +01:00
Andre Delfino b15fff620f
[3.8] [doc] Fix link to abc.collections.Iterable (GH-22502) (#22504)
Automerge-Triggered-By: @gvanrossum.
(cherry picked from commit d4b9edd505)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-10-11 10:32:02 -07:00
Miss Skeleton (bot) ae485f5240
Fix incorrect parameter name (GH-22613)
Automerge-Triggered-By: @Mariatta
(cherry picked from commit a42759351b)

Co-authored-by: Xie Yanbo <xieyanbo@gmail.com>
2020-10-09 21:50:23 -07:00
Miss Skeleton (bot) 6bd058e0ff
bpo-41892: Clarify that an example in the ElementTree docs explicitly avoids modifying an XML tree while iterating over it. (GH-22464)
(cherry picked from commit 40db798692)

Co-authored-by: scoder <stefan_ml@behnel.de>
2020-10-04 16:23:43 -07:00
Miss Skeleton (bot) b2611fac05
bpo-41898: add caveat on root logger seeing all messages in assertLogs doc (GH-22526) (GH-22537)
(cherry picked from commit 1ed5443526)
2020-10-04 14:27:14 +01:00
Miss Skeleton (bot) c3cd440e7b
[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:00:38 -07:00
Miss Skeleton (bot) 4b982e0dd7
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 03:11:39 -07:00
Miss Islington (bot) 4c2e299d80
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:50:07 -07:00
Miss Islington (bot) e0e614ca99
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 20:52:01 -07:00
Miss Islington (bot) 5acc1b5f0b
bpo-37062: Enum: add extended AutoNumber example (GH-22349) (GH-22369)
(cherry picked from commit 62e40d8450)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2020-09-22 20:57:48 -07:00
Miss Islington (bot) 2466a7ae6b
bpo-35764: Rewrite the IDLE Calltips doc section (GH-22363)
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2020-09-22 14:36:02 -04:00
Miss Islington (bot) c5cddc17b5
bpo-41762: Fix usage of productionlist markup in the doc (GH-22281) (GH-22300)
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 10:31:28 +02:00
Serhiy Storchaka 038688a53b
[3.8] Remove duplicated words words (GH-20413). (GH-22297)
(cherry picked from commit 1c5d1d7304)
2020-09-18 09:37:04 +03:00
Miss Islington (bot) 5fdc142597
Improve the description of difflib in the documentation (GH-22253) (GH-22260)
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:29 -07:00
Miss Islington (bot) 624cc10ee4
bpo-40721: add note about enum member name case (GH-22231)
* UPPER_CASE preferred as enum members are constants
(cherry picked from commit 542e1df2b0)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2020-09-14 13:42:38 -07:00
Miss Islington (bot) d09bead939
bpo-41778: Change a punctuation on documentation. (GH-22229) (GH-22230)
On this paragrapah the clarification about IIS7 seems there's not
connection beacuase is in other sentence. Move the punctuation
to connect both the last sentence with the information in the
parenthesis.

I think the NEWS is not necessary here.

Automerge-Triggered-By: @ericvsmith
(cherry picked from commit 94bfdee25d)

Co-authored-by: Emmanuel Arias <eamanu@yaerobi.com>
2020-09-13 17:21:49 -04:00
Ethan Furman 38c8d3930e
[3.8] bpo-37479: Enum - use correct __format__ (GH-14545)
* bpo-37479: on Enum subclasses with mixins, __format__ uses overridden __str__.
(cherry picked from commit 2f19e82fbe)

Co-authored-by: thatneat <thatneat@users.noreply.github.com>
2020-09-13 13:47:43 -07:00
Miss Islington (bot) bf50b0e80a
bpo-33239: Fix default value of 'buffering' parameter in docs of tempfile.* functions (GH-21763) (GH-22226)
(cherry picked from commit b48389d950)
2020-09-13 19:16:39 +01:00
Miss Islington (bot) 3a150c77c3
bpo-41672: Fix type mismatches in imaplib docs (GH-22207) (#22218)
(cherry picked from commit c75330605d)

Co-authored-by: Norbert Cyran <cyran.norbert97@gmail.com>

Co-authored-by: Norbert Cyran <cyran.norbert97@gmail.com>
2020-09-12 20:04:50 +09:00
Miss Islington (bot) e4c6947024
[doc] struct: update note about network byte order form to be more helpful (GH-22201)
Update the sentence to provide some context on why network byte order is defined as big endian.
(cherry picked from commit fb27187203)

Co-authored-by: Stargirl Flowers <theaflowers@google.com>
2020-09-11 08:29:04 -07:00
Miss Islington (bot) 8a30bdd21d
bpo-37149: Change Shipman tkinter link from archive.org to TkDocs (GH-22188) (#22193)
The new link responds much faster and begins with a short explanation of the status of the doc.
(cherry picked from commit 06d0b8b67e)

Co-authored-by: Mark Roseman <mark@markroseman.com>
2020-09-10 16:21:35 -04:00
Miss Islington (bot) d423aa8e95
Add missing colon to IDLE doc markup (GH-22007)
(cherry picked from commit 7a797a3967)

Co-authored-by: Andre Delfino <adelfino@gmail.com>

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-09-09 18:34:20 -04:00