summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* bpo-42669: Document that `except` rejects nested tuples (GH-23822) (GH-23871)Miss Islington (bot)2020-12-201-1/+2
| | | | | | | | | | | | | | | | | | 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 c95f8bc2700b42f4568886505a819816c9b0ba28) Co-authored-by: Colin Watson <cjwatson@debian.org> Co-authored-by: Colin Watson <cjwatson@debian.org>
* bpo-41724: Explain when the conversion is not possible with detect_types ↵Miss Islington (bot)2020-12-201-1/+3
| | | | | | | | enabled (GH-23855) (GH-23863) * Explain when the conversion is not possible with detect_types enabled (cherry picked from commit 09a36cdfb7c22f44df45b44e5561776206bcedfb) Co-authored-by: sblondon <sblondon@users.noreply.github.com>
* [3.8] bpo-17140: Document multiprocessing's ThreadPool (GH-23812) (GH-23835)Miss Islington (bot)2020-12-181-0/+40
| | | | | | | | | 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 84ebcf271a2cc8bfd1762acb279502b8b6ef236e) Co-authored-by: Matt Wozniski <mwozniski@bloomberg.net>
* bpo-39096: Format specification documentation fixes for numeric types (GH-23575)Miss Islington (bot)2020-12-181-12/+23
| | | | | (cherry picked from commit 886b2e5c7a2caf87070728dba8f18c3d65e51071) Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
* [3.8] bpo-39416: change word case to not imply ABC (GH-22867) (GH-22869)Miss Islington (bot)2020-12-161-1/+1
| | | | | follow-up to bpo-39416 Co-authored-by: kpinc <kop@karlpinc.com>
* [3.8] [doc] Link to issue regarding logging.disable level param default ↵Andre Delfino2020-12-101-2/+2
| | | | | | | value GH-23731 (cherry picked from commit 2a35137328154aa2513649dcf0bbef02c998e27c) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* bpo-37221: PyCode_New() didn't change in Python 3.8 (GH-23595)Miss Islington (bot)2020-12-011-3/+0
| | | | | (cherry picked from commit 1867b462de427bcb8dfbcd256028410aea6ae929) Co-authored-by: Victor Stinner <vstinner@python.org>
* Fix bz2 examples markup (GH-23580)Miss Islington (bot)2020-12-011-8/+0
| | | | | (cherry picked from commit 80a429eae95c15c2c2a6753376f2697c90c2b6b9) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* bpo-39096: Improve description of 'e', 'f' and 'g' presentation types ↵Miss Islington (bot)2020-11-291-12/+31
| | | | | | | | | | | | | | | | | | (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 c642374b3ef72f6f300616f07aea2a3f9ed83e51) Co-authored-by: Mark Dickinson <mdickinson@enthought.com> Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
* Fix multiprocessing markup (GH-23525)Miss Islington (bot)2020-11-281-3/+3
| | | | | (cherry picked from commit 4b44472966f17ad96d4370569ae049de9873e4af) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* bpo-42489: Fix the signature for list.sort() in the tutorial (GH-23538)Miss Islington (bot)2020-11-281-1/+1
| | | | | (cherry picked from commit d41ec65ab7411e877ca33d05e8c900feca530635) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-17852: Doc: Fix the tutorial about closing files (GH-23135)Miss Islington (bot)2020-11-271-5/+10
| | | | | | Co-authored-by: Inada Naoki <songofacandy@gmail.com> (cherry picked from commit c8aaf71dde4888864c0c351e2f935f87652c3d54) Co-authored-by: Volker-Weissmann <39418860+Volker-Weissmann@users.noreply.github.com>
* Doc: fix typo in typing.Type docs (GH-23460)Miss Islington (bot)2020-11-221-1/+1
| | | | | (cherry picked from commit 5ef53a88f3130cfcf9a9be3abd2ff2f997902647) Co-authored-by: John Belmonte <john@neggie.net>
* bpo-42391: Clarify documentation of TestCase.assertIs (GH-23348)Miss Islington (bot)2020-11-221-2/+1
| | | | | | Removing 'evaluate' makes it more consistent with other assertX entries. (cherry picked from commit bd8c22e1fa8f8f6e31ee083a8b9321a2c324f02f) Co-authored-by: Ram Rachum <ram@rachum.com>
* Fix wrong availability for signal.SIGCHLD (GH-23285) (#23426)Miss Islington (bot)2020-11-211-1/+1
| | | | | | | | I believe this is a mistake. SIGCHLD is only available on Unix systems, not Windows. (cherry picked from commit 4c24b08cd3239b417a5f8c7ba2ba54c840d051e3) Co-authored-by: Zhang Maiyun <myzhang1029@hotmail.com> Co-authored-by: Zhang Maiyun <myzhang1029@hotmail.com>
* bpo-42412: Fix possible leaks and check arguments in ↵Miss Islington (bot)2020-11-211-2/+4
| | | | | | | | | | | 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 1db76394ea79030aa4ed5349c950f6c6da51450f) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* bpo-42407: Use possessive appostrophe in multiprocessing doc (GH-23400)Miss Islington (bot)2020-11-211-1/+1
| | | | | (cherry picked from commit 6edf06b24a9335a2b0d44634a95e4f5ba0d586d9) Co-authored-by: ArioA <ArioA@users.noreply.github.com>
* [3.8] bpo-38320: Clarify that expectedFailure is satisfied by either failure ↵Miss Islington (bot)2020-11-181-5/+6
| | | | | | | | or error of the test. (GH-22740) (GH-22782) (cherry picked from commit fa8748271a61177e9bf609921fa464cc6990478b) Co-authored-by: Irit Katriel <iritkatriel@yahoo.com>
* [3.8] Remove outdated reference to pywin32 from platform module (GH-22005) ↵Miss Islington (bot)2020-11-171-7/+0
| | | | | | | | (GH-23184) (cherry picked from commit 7c01f1540f958d4f52188b28afca721a9a6925c3) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* bpo-42339: Adds note about KB2533623 to embeddable package docs (GH-23322)Steve Dower2020-11-161-0/+6
|
* bpo-42153 Fix link to IMAP documents in imaplib.rst (GH-23297)Miss Islington (bot)2020-11-161-3/+3
| | | | | | The University of Washington stopped hosting the IMAP documents. Link to a rescued copy on GitHub. (cherry picked from commit aa01011003bb855cd52abfd49f2443446590d913) Co-authored-by: Yash Shete <universeyash4@gmail.com>
* fix typo in ThreadedChildWatcher docs (GH-23277)Miss Islington (bot)2020-11-141-1/+1
| | | | | (cherry picked from commit 8836574a0f34ae81643c8af79bbb9062e332a4e3) Co-authored-by: Thomas Grainger <tagrain@gmail.com>
* bpo-42344: Improve pseudo implementation for SimpleNamespace (GH-23264) ↵Miss Islington (bot)2020-11-131-1/+3
| | | | | | | | | (GH-23269) (cherry picked from commit bbeb2d266d6fc1ca9778726d0397d9d6f7a946e3) Co-authored-by: Jürgen Gmach <juergen.gmach@googlemail.com> Co-authored-by: Jürgen Gmach <juergen.gmach@googlemail.com>
* bpo-42042: Use ids attribute instead of names attribute (GH-22739)Miss Islington (bot)2020-11-131-2/+2
| | | | | (cherry picked from commit 09490a109faaee9cc393b52742a8575c116c56ba) Co-authored-by: Dong-hee Na <donghee.na@python.org>
* Minor wording change in concurrent.futures. (GH-23194)Miss Islington (bot)2020-11-081-3/+3
| | | | | | Fixes a grammar problem by adding a missing "as", and clarifies the wording of the valid ranges for max_workers. (cherry picked from commit fd6f6fa403789c8877b1099cc6fcc437d2e54634) Co-authored-by: Don Kirkby <donkirkby@users.noreply.github.com>
* [3.8] bpo-42230: Improve asyncio documentation regarding accepting sets vs ↵Jakub Stasiak2020-11-021-3/+3
| | | | | | | | | | | | | | | | | 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] https://github.com/python/typeshed/blob/620989bac572f30349b95590ebe81a73ce0fe862/stdlib/3/asyncio/tasks.pyiGH-L161 [3] https://github.com/python/typeshed/blob/620989bac572f30349b95590ebe81a73ce0fe862/stdlib/3/asyncio/tasks.pyiGH-L40. (cherry picked from commit 3d86d090dcbbdfdd3e5a5951cab30612d6131222) Co-authored-by: Jakub Stasiak <jakub@stasiak.at>
* bpo-6761: Enhance __call__ documentation (GH-7987)Miss Skeleton (bot)2020-10-271-1/+1
| | | | | (cherry picked from commit 95f710c55714153f0c8cce48f8215bb3d866ac1d) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* Add a link to buffer protocol in bytearray() doc (GH-22675)Miss Skeleton (bot)2020-10-261-2/+2
| | | | | (cherry picked from commit 0f25c231b3a024e358c3e55d9aba2f7bcc49630c) Co-authored-by: Antoine <43954001+awecx@users.noreply.github.com>
* bpo-29981: Add examples and update index for set, dict, and generator ↵Miss Skeleton (bot)2020-10-253-0/+30
| | | | | | | | comprehensions'(GH-20272) Co-authored-by: Rémi Lapeyre <remi.lapeyre@henki.fr> (cherry picked from commit 2d55aa9e37c9c84f4f6a8135d0326da0bcd8f38b) Co-authored-by: Florian Dahlitz <f2dahlitz@freenet.de>
* [doc] Fix link to abc.ABCMeta.register in Glossary (GH-22932)Miss Skeleton (bot)2020-10-251-1/+1
| | | | | (cherry picked from commit e01e442125bbc98e6dab66f38ecc6c45f69e6587) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* [3.8] bpo-38486: Fix dead qmail links in the mailbox docs (GH-22239) (GH-22902)Miss Skeleton (bot)2020-10-221-10/+4
| | | | | | | | (cherry picked from commit ec388cfb4ede56dace2bb78851ff6f38fa2a6abe) Co-authored-by: Zackery Spytz <zspytz@gmail.com> Automerge-Triggered-By: GH:warsaw
* bpo-25655: Improve Win DLL loading failures doc (GH-22372)Miss Skeleton (bot)2020-10-221-0/+15
| | | | | | | | | 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 b6f2fc90409e291822166d74ce7402e0ef4dba91) Co-authored-by: Philippe Ombredanne <pombredanne@gmail.com>
* [3.8] Remove 3.5 from Doc version switcher in master. (GH-22886) (#22889)larryhastings2020-10-222-2/+0
| | | (cherry picked from commit 283f9a253b4ff4df728558205629b3bb3af6e47f)
* bpo-41910: specify the default implementations of object.__eq__ and ↵Miss Skeleton (bot)2020-10-221-6/+8
| | | | | | | 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>
* bpo-35181: Correct importlib documentation for some module attributes (GH-15190)Miss Skeleton (bot)2020-10-212-21/+11
| | | | | | | | | | | | | | | | | | @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 27f1bd8787d24ac53cc3dc6ea5eb00b8a3499839) Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
* [3.8] bpo-41959: Fix grammar around class asyncio.MultiLoopChildWatcher text ↵Miss Skeleton (bot)2020-10-211-1/+1
| | | | | | | | | (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 caff2934f46510920a6169e192707d59e9c55f6b) Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
* [3.8] bpo-39416: Document some restrictions on the default string ↵Miss Skeleton (bot)2020-10-211-0/+18
| | | | | | | | | | | | | | | | | | | | | | 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 c60394c7fc9cc09b16e9675a3eeb5844b6d8523f) Co-authored-by: kpinc <kop@karlpinc.com> Automerge-Triggered-By: GH:merwok
* Doc: Fix a typo/error in the docs for cached bytecode (GH-22445)Miss Skeleton (bot)2020-10-211-1/+1
| | | | | (cherry picked from commit cb115e36e1aba04b90b0ecac6f043e60064ac65b) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* Doc: Do not suggest `s[::-1]` for reversed order (GH-22457)Miss Skeleton (bot)2020-10-212-7/+1
| | | | | (cherry picked from commit fb2e94692e3a8eb66915575f4a122d56fe8999a0) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* Doc: Remove old Python version from future stmt (GH-21802)Miss Skeleton (bot)2020-10-211-2/+2
| | | | | (cherry picked from commit eba109a28f48b20b05f08abbe6604eebb07788f9) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* bpo-41646: Mention path-like objects support in the docs for shutil.copy() ↵Miss Skeleton (bot)2020-10-211-3/+3
| | | | | | | (GH-22208) (cherry picked from commit 8f2b991eef062c22c429a96983c78be007180b66) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-41192: Add documentation of undocumented audit events (GH-22832)Miss Skeleton (bot)2020-10-205-2/+56
| | | | (cherry picked from commit 3f7e990fd49dbabc1dde41ce58c1bdda9f56ead7)
* bpo-41192: Clarify the sys module's description of the auditing feature ↵Miss Skeleton (bot)2020-10-201-10/+25
| | | | | | | | | | (GH-22820) Co-authored-by: Éric Araujo <merwok@netwok.org> (cherry picked from commit 0c37269be7065b9b15b7b3a4406084f9535a793a) Co-authored-by: Andrew Kuchling <amk@amk.ca> Co-authored-by: Andrew Kuchling <amk@amk.ca>
* Doc: Add missing spaces after period for `posix_spawn` (GH-22730)Miss Skeleton (bot)2020-10-201-2/+2
| | | | | (cherry picked from commit 5b57fa69408c4856bf0ae02f2eaa3db1ef980ea6) Co-authored-by: Tomer Cohen <tomer@users.noreply.github.com>
* bpo-30612: Tweak Windows registry path syntax in the docs (GH-20281)Miss Skeleton (bot)2020-10-201-3/+3
| | | | | (cherry picked from commit ff1ae3dd334faa2006394c2318db385cdc42030a) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-40901: Describe what "interface name" means on Windows (GH-20694)Miss Skeleton (bot)2020-10-191-0/+19
| | | | | (cherry picked from commit f85658a09878c658ae0e0590bfa30e4ce51c9a04) Co-authored-by: Jakub Stasiak <jakub@stasiak.at>
* bpo-41217: Fix incorrect note in the asyncio.create_subprocess_shell() docs ↵Miss Skeleton (bot)2020-10-191-4/+2
| | | | | | | | (GH-21360) On Windows, the default asyncio event loop is ProactorEventLoop (as of 3.8). (cherry picked from commit 4dfb190a33a1deac60306f15d52d2fe11fb93464) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-41292: Fixes dead link to cx_freeze from Windows FAQ (GH-21463)Miss Skeleton (bot)2020-10-191-1/+1
| | | | | (cherry picked from commit 33242a9328cb3912f02819d2d092bf89681000b2) Co-authored-by: Michel Samia <m.samia@seznam.cz>
* Link to the msvcrt module from the Windows FAQ (GH-22268)Miss Skeleton (bot)2020-10-191-1/+1
| | | | | (cherry picked from commit 5d9e6575177f3e5f9aa20d6a08ae1204f122e672) Co-authored-by: abdo <abd.nh25@gmail.com>
* bpo-41192: Fix some broken anchors for audit event entries (GH-21310) (GH-22770)Miss Skeleton (bot)2020-10-193-4/+3
| | | | | (cherry picked from commit ebc8c3828779374b9be4fae5c8ffc0059d36ac8c) Co-authored-by: Saiyang Gou <gousaiyang@163.com>