Commit Graph

23034 Commits

Author SHA1 Message Date
Julien Palard 218ed0b013
Revert "[3.8] [doc] Fix erroneous backslashes in signatures and names (GH-23658)" (GH-24093)
This partially reverts commit
02349e2dc9, which was removing
backslashes in documentations compiled with Sphinx < 3, used for
Python 3.8 and 3.9 docs.
2021-01-04 17:19:16 +01:00
Serhiy Storchaka 82794cacc6
[3.8] [3.9] bpo-42681: Fix range checks for color and pair numbers in curses (GH-23874). (GH-24077) (GH-24079)
(cherry picked from commit 1470edd613)
(cherry picked from commit b0ee2b492d)
2021-01-04 10:58:09 +02:00
Miss Islington (bot) 02639c3bc6
Bring Python into the new year. (GH-24036)
(cherry picked from commit de6f20a6de)

Co-authored-by: Dong-hee Na <donghee.na@python.org>
2021-01-01 09:28:23 -08:00
Miss Islington (bot) 82f24ff344
Fixes a typo in importlib.metadata. (GH-23921) (#24030)
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:04 -08:00
Andre Delfino bc15cdbc6e
[3.8] bpo-41224: Add versionadded for Symbol.is_annotated (GH-23861). (GH-24016)
(cherry picked from commit 2edfc86f69)
2020-12-31 15:10:46 +02:00
Miss Islington (bot) 70ced2dd27
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:42:05 -08:00
Miss Islington (bot) 8f9313c83f
[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:47 -08:00
Miss Islington (bot) e11639880a
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:21:43 -08:00
Miss Islington (bot) d5aadb2854
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:13 -08:00
Miss Islington (bot) 412c935a37
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:14:27 -08:00
Andre Delfino 02349e2dc9
[3.8] [doc] Fix erroneous backslashes in signatures and names (GH-23658) (GH-23828)
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:56:55 -08:00
Andre Delfino d3ab4c82a9
[3.8] [doc] Fix a few margins due to bad markup (GH-23619). (GH-23860)
(cherry picked from commit 96a09df644)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-12-21 18:55:19 -08:00
Miss Islington (bot) 81f706d2db
bpo-42669: Document that `except` rejects nested tuples (GH-23822) (GH-23871)
In Python 2, it was possible to use `except` with a nested tuple, and occasionally natural.  For example, `zope.formlib.interfaces.InputErrors` is a tuple of several exception classes, and one might reasonably think to do something like this:

    try:
        self.getInputValue()
        return True
    except (InputErrors, SomethingElse):
        return False

As of Python 3.0, this raises `TypeError: catching classes that do not inherit from BaseException is not allowed` instead: one must instead either break it up into multiple `except` clauses or flatten the tuple.  However, the reference documentation was never updated to match this new restriction.  Make it clear that the definition is no longer recursive.

Automerge-Triggered-By: GH:ericvsmith
(cherry picked from commit c95f8bc270)

Co-authored-by: Colin Watson <cjwatson@debian.org>

Co-authored-by: Colin Watson <cjwatson@debian.org>
2020-12-20 16:18:40 -05:00
Miss Islington (bot) 24862b02df
bpo-41724: Explain when the conversion is not possible with detect_types enabled (GH-23855) (GH-23863)
* 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>
2020-12-19 19:02:58 -05:00
Miss Islington (bot) d21d29ab5b
[3.8] bpo-17140: Document multiprocessing's ThreadPool (GH-23812) (GH-23835)
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 10:37:57 -08:00
Miss Islington (bot) 12032cdec5
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:34:24 -08:00
Miss Islington (bot) aedc94b8e9
[3.8] bpo-39416: change word case to not imply ABC (GH-22867) (GH-22869)
follow-up to bpo-39416

Co-authored-by: kpinc <kop@karlpinc.com>
2020-12-15 22:18:17 -05:00
Andre Delfino 150b9bf3e9
[3.8] [doc] Link to issue regarding logging.disable level param default value GH-23731
(cherry picked from commit 2a35137328)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-12-10 06:19:51 -08:00
Miss Islington (bot) d9d63f13cf
bpo-37221: PyCode_New() didn't change in Python 3.8 (GH-23595)
(cherry picked from commit 1867b462de)

Co-authored-by: Victor Stinner <vstinner@python.org>
2020-12-01 07:34:01 -08:00
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) e1c669b7ed
bpo-42489: Fix the signature for list.sort() in the tutorial (GH-23538)
(cherry picked from commit d41ec65ab7)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2020-11-28 07:02:23 -08:00
Miss Islington (bot) 01fcde89d7
bpo-17852: Doc: Fix the tutorial about closing files (GH-23135)
Co-authored-by: Inada Naoki <songofacandy@gmail.com>
(cherry picked from commit c8aaf71dde)

Co-authored-by: Volker-Weissmann <39418860+Volker-Weissmann@users.noreply.github.com>
2020-11-26 16:51:54 -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) 648a32b12e
bpo-42412: Fix possible leaks and check arguments in PyType_FromModuleAndSpec() (GH-23410)
* There were leaks if Py_tp_bases is used more than once or if some call is
  failed before setting tp_bases.
* There was a crash if the bases argument or the Py_tp_bases slot is not a tuple.
* The documentation was not accurate.
(cherry picked from commit 1db76394ea)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2020-11-21 02:39:23 -08: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
Steve Dower fa86614078
bpo-42339: Adds note about KB2533623 to embeddable package docs (GH-23322) 2020-11-16 21:28:29 +00: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) 5ad468d4a8
bpo-42042: Use ids attribute instead of names attribute (GH-22739)
(cherry picked from commit 09490a109f)

Co-authored-by: Dong-hee Na <donghee.na@python.org>
2020-11-13 07:30:10 -08: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) b1ce0440bf
bpo-6761: Enhance __call__ documentation (GH-7987)
(cherry picked from commit 95f710c557)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-10-27 09:28:00 -07: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) eac21a048b
[doc] Fix link to abc.ABCMeta.register in Glossary (GH-22932)
(cherry picked from commit e01e442125)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-10-24 17:32:36 -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
larryhastings 6a5c70ac1f
[3.8] Remove 3.5 from Doc version switcher in master. (GH-22886) (#22889)
(cherry picked from commit 283f9a253b)
2020-10-22 07:29:54 -07:00
Miss Skeleton (bot) b2b3803081
bpo-41910: specify the default implementations of object.__eq__ and object.__ne__ (GH-22874) (#22877)
See Objects/typeobject.c:object_richcompare() for the implementation of this in CPython.

Co-authored-by: Brett Cannon <brett@python.org>
2020-10-21 20:07:59 -04: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) 89fac4c374
[3.8] bpo-39416: Document some restrictions on the default string representations of numeric classes (GH-18111) (GH-22861)
[[bpo-39416]()](): Document string representations of the Numeric classes

This is a change to the specification of the Python language.

The idea here is to put sane minimal limits on the Python language's default
representations of its Numeric classes.  That way "Marty's Robotic Massage Parlor
and Python Interpreter" implementation of Python won't do anything too
crazy.

Some discussion in the email thread:
Subject: Documenting Python's float.__str__()
https://mail.python.org/archives/list/python-dev@python.org/thread/FV22TKT3S2Q3P7PNN6MCXI6IX3HRRNAL/
(cherry picked from commit c60394c7fc)


Co-authored-by: kpinc <kop@karlpinc.com>

Automerge-Triggered-By: GH:merwok
2020-10-21 11:56:20 -07:00
Miss Skeleton (bot) a8e6af798e
Doc: Fix a typo/error in the docs for cached bytecode (GH-22445)
(cherry picked from commit cb115e36e1)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2020-10-21 01:46:22 -07:00