Commit graph

23866 commits

Author SHA1 Message Date
Alex Waygood
8813a987b1
[3.9] bpo-45655: Add "relevant PEPs" section to typing documentation (GH-29297)
Backport of https://github.com/python/cpython/pull/29280 to the 3.9 branch.
2021-10-28 23:17:28 +02:00
Miss Islington (bot)
3767e0d943
bpo-45583: Correct datamodel documentation of int() (GH-29182) (GH-29286)
It should be noted that this part of the documentation is redundant with
function.rst's documentation of int. This one was correctly updated with Python 3.8.
(cherry picked from commit d9c1868c25)

Co-authored-by: Arthur Milchior <arthur@milchior.fr>
2021-10-28 22:17:20 +02:00
Miss Islington (bot)
01d11b1d62
bpo-45604: add level argument to multiprocessing.log_to_stderr func (GH-29226) (GH-29284)
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
(cherry picked from commit 1fb968c07a)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2021-10-28 22:03:32 +02:00
Miss Islington (bot)
020aa06ec8
bpo-45608: Document missing sqlite3 DB-API attributes and methods (GH-29219) (GH-29282)
(cherry picked from commit 88d8a1a340)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2021-10-28 21:57:35 +02:00
Miss Islington (bot)
193504acf3
bpo-28737: Document when tp_dealloc should call PyObject_GC_UnTrack() (GH-29246) (GH-29248)
Objects that support garbage collection ("container" objects) should
call PyObject_GC_UnTrack() from their destructors before clearing any
fields which may point to other "container" objects.
(cherry picked from commit 35e1ff38ee)

Co-authored-by: Sam Gross <colesbury@gmail.com>
2021-10-28 21:23:19 +02:00
Ned Deily
30c1f18ee6
[3.9] bpo-45618: Fix documentation build by pinning Docutils version to 0.17.1 (GH-29230) (GH-29241)
Co-authored-by: Maciej Olko <maciej.olko@yougov.com>
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2021-10-27 11:04:38 -04:00
Miss Islington (bot)
c53428fe89
bpo-44344: Document that pow can return a complex number for non-complex inputs. (GH-27853) (GH-29134)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 887a55705b)

Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
2021-10-22 00:08:36 +02:00
Miss Islington (bot)
b26eae54e9
bpo-41983: add availability info to socket docs (GH-27519) (GH-29137)
* add availability info to AF_PACKET section
* add availability for AF_QIPCRTR as well

(cherry picked from commit 51375388be)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2021-10-22 00:07:38 +02:00
Ethan Furman
e628700dbf
[3.9] bpo-44174: [Enum] add name-mangling reference (GH-29128) 2021-10-21 11:32:18 -07:00
Miss Islington (bot)
bfa4237ecf
bpo-34451: Document prompt and output toggle feature in html tutorial (GH-27105) (GH-29120)
(cherry picked from commit 5a14f71fe8)

Co-authored-by: Thomas <thmsdnnr@gmail.com>
2021-10-21 14:42:10 +02:00
Ethan Furman
9733c9651a
[3.9] bpo-42517: [ENUM] update docs for changes coming in 3.11 (GH-29113) 2021-10-20 16:11:47 -07:00
Miss Islington (bot)
427ab124b3
bpo-45464: [doc] Explain that subclassing multiple exceptions is fragile (GH-29094) (GH-29105)
Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
(cherry picked from commit dff0b71343)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-10-20 20:50:28 +02:00
Łukasz Langa
a18e4e9c15
[3.9] bpo-45449: add note about PEP 585 in collections.abc's documentation (GH-29047) (GH-29068)
Signed-off-by: Filipe Laíns <lains@riseup.net>

Co-authored-by: Łukasz Langa <lukasz@langa.pl>.
(cherry picked from commit 7bafa0cf58)

Co-authored-by: Filipe Laíns <lains@riseup.net>
2021-10-19 20:50:09 +02:00
Miss Islington (bot)
76578884c5
bpo-45515: Add zoneinfo to the datetime documentation (GH-29038) (GH-29066)
We should have done this way back when 3.9 was released, but it fell off
the radar.

Co-authored-by: Paul Ganssle <git@m.ganssle.io>
(cherry picked from commit 8e40ca127f)
2021-10-19 20:35:56 +02:00
Miss Islington (bot)
cb34c1ee1b
Improve multiserver queue recipe (GH-29012) (GH-29014) 2021-10-18 00:24:51 -05:00
Miss Islington (bot)
ac1b7a3319
[3.9]bpo-45463: Clarify that global statements allows multiple names (GH-28851) (GH-28990)
The global statement allows specifying a list of identifiers
(https://docs.python.org/3/reference/simple_stmts.htmlGH-the-global-statement).

The "Execution model" chapter described the global statement as if it
only allowed one single name. Pluralize "name" in the appropriate places.
(cherry picked from commit 4ecd119b00)

Co-authored-by: Luca Chiodini <luca@chiodini.org>

Co-authored-by: Luca Chiodini <luca@chiodini.org>
2021-10-16 10:01:14 -04:00
Serhiy Storchaka
6848602806
bpo-45467: Fix IncrementalDecoder and StreamReader in the "raw-unicode-escape" codec (GH-28944) (GH-28953)
They support now splitting escape sequences between input chunks.

Add the third parameter "final" in codecs.raw_unicode_escape_decode().
It is True by default to match the former behavior.

(cherry picked from commit 39aa98346d)
2021-10-14 21:23:52 +03:00
Serhiy Storchaka
7c722e32bf
[3.9] bpo-45461: Fix IncrementalDecoder and StreamReader in the "unicode-escape" codec (GH-28939) (GH-28945)
They support now splitting escape sequences between input chunks.

Add the third parameter "final" in codecs.unicode_escape_decode().
It is True by default to match the former behavior.
(cherry picked from commit c96d1546b1)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2021-10-14 20:03:29 +03:00
Miss Islington (bot)
cc90732d15
bpo-20692: Add Programming FAQ entry for 1.__class__ error. (GH-28918)
To avoid error, add either space or parentheses.
(cherry picked from commit 380c440875)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-10-12 22:40:18 -07:00
Miss Islington (bot)
0cd5bf9194
Slight correct grammar (GH-28860)
(cherry picked from commit 1b11582f0e)

Co-authored-by: nobodyatandnothing <91722596+nobodyatandnothing@users.noreply.github.com>
2021-10-12 10:01:26 -07:00
Miss Islington (bot)
38e3ada75a
bpo-45441: Update some moved URLs in documentation (GH-28861)
(cherry picked from commit b37dc9b3bc)

Co-authored-by: 180909 <wjh180909@gmail.com>
2021-10-12 07:20:50 -07:00
Miss Islington (bot)
23528905d4
bpo-42253: Update xml.dom.minidom.rst (GH-23126) (GH-28875)
Document that the "standalone" parameter was added in Python 3.9.
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
(cherry picked from commit c7e81fcf95)

Co-authored-by: Jens Diemer <github.com@jensdiemer.de>
2021-10-12 10:18:15 +03:00
Miss Islington (bot)
320084fe7d
bpo-45351, asyncio: Enhance echo server example, print all addresses (GH-28828)
(cherry picked from commit 659812b451)

Co-authored-by: Olaf van der Spek <olafvdspek@gmail.com>
2021-10-11 12:34:51 -07:00
Miss Islington (bot)
5f44bb28fd
Fix the "Finding all Adverbs" example (GH-21420) (#28840)
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
(cherry picked from commit dbd62e74da)

Co-authored-by: Rim Chatti <chattiriim@gmail.com>
2021-10-10 14:43:58 -07:00
Miss Islington (bot)
4f161e65a0
[doc] Mention __slots__ behavior in weakref.rst (GH-21061) (GH-28773)
It took me longer than I expected to figure out why a random class
I dealt with didn't support weak references. I believe this addition
will make the __slots__/weakref interaction more discoverable to people
having troubles with this. (Before this patch __slots__ was not
mentioned in weakref documentation even once).

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit b24b47e643)

Co-authored-by: Jakub Stasiak <jakub@stasiak.at>
2021-10-06 20:52:48 +02:00
Miss Islington (bot)
496d1aa0b8
bpo-34804: [doc] Rephrase section on side effects in functional.rst for clarity (GH-27989) (GH-28763)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 7af95a1e80)

Co-authored-by: DonnaDia <37962843+DonnaDia@users.noreply.github.com>
2021-10-06 17:19:46 +02:00
Christian Clauss
edef03aaa8
[3.9] [doc] Fix typos found using codespell (GH-28744) (GH-28759) 2021-10-06 15:57:39 +02:00
Miss Islington (bot)
d747f5e805
[doc] Update references to NumPy (GH-22458) (GH-28749)
Numeric(al) Python to NumPy. It seems the old name hasn't been used for some time.
(cherry picked from commit c8bb24166e)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2021-10-06 15:04:48 +02:00
Miss Islington (bot)
92450f23c6
sqlite3: Modernize documentation around unicode and bytes. (GH-28652) (GH-28695)
(cherry picked from commit 1dac95c814)

Co-authored-by: Julien Palard <julien@palard.fr>
2021-10-05 23:04:02 +02:00
Miss Islington (bot)
950b324973
[doc] Fix gethostbyname_ex description (GH-28700) (GH-28743)
It seems part of `gethostbyname_ex` doc was copied from `gethostbyaddr`. The latter has an `ip_address` parameter whereas the former doesn't.
(cherry picked from commit 4103280b83)

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

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2021-10-05 19:22:14 +02:00
Miss Islington (bot)
d211e87307
bpo-45341: Replace 'Packaging' with 'Package' in "Python P... Index" (GH-28687) (GH-28689)
pypi.org "  The Python Package Index (PyPI) ...
(cherry picked from commit 0be338199f)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-10-02 10:15:45 -04:00
Łukasz Langa
68223cd12f
[3.9] [docs] Improve the markup of powers (GH-28598) (GH-28608)
(cherry picked from commit 4f05f15d7b)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2021-09-28 23:13:16 +02:00
Miss Islington (bot)
fe7746c61a
[doc] fix minor typo for argparse (GH-28451)
"A JSONDecodeError" instead of "An JSONDecodeError".
(cherry picked from commit db0133f98d)

Co-authored-by: Louis Sautier <sautier.louis@gmail.com>
2021-09-28 07:07:20 -07:00
Miss Islington (bot)
2a7d985bb3
bpo-45277: Fix typo in codecs doc (GH-28555)
encoding => encode
(cherry picked from commit 4c0fc65cd8)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-09-24 19:22:54 -07:00
Miss Islington (bot)
d672dd34f0
bpo-38623: Add note about site module (site-packages) (GH-16974) (GH-28537)
(cherry picked from commit 55b45bf707)

Co-authored-by: Peter Bittner <django@bittner.it>
2021-09-24 00:48:26 +02:00
Miss Islington (bot)
b97f1f82a3
[docs] Update documentation for multiprocessing.get_start_method (GH-18170) (GH-28534)
(cherry picked from commit af90b5498b)

Co-authored-by: Sam Sneddon <me@gsnedders.com>
2021-09-23 23:39:08 +02:00
Miss Islington (bot)
7fa76ece30
[3.9] Fix legacy logging module URL (GH-28528) (GH-28531)
Co-authored-by: Sean Leavey <SeanDS@users.noreply.github.com>
2021-09-23 16:42:31 +01:00
Miss Islington (bot)
f1d5cdef57
bpo-41203: Replace Mac OS X and OS X with macOS (GH-28515) (GH-28524)
Replace old names when they refer to actual versions of macOS.
Keep historical names in references to older versions.

Co-authored-by: Patrick Reader <_@pxeger.com>
(cherry picked from commit 36122e1814)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2021-09-23 13:25:57 +03:00
Łukasz Langa
5482db5800
[3.9] [codemod] Fix non-matching bracket pairs (GH-28473) (GH-28512)
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>.
(cherry picked from commit 8f943ca257)

Co-authored-by: Mohamad Mansour <66031317+mohamadmansourX@users.noreply.github.com>
2021-09-22 17:32:04 +02:00
Miss Islington (bot)
aea92de990
bpo-45246: Document that sorted() only uses "<" comparisons (GH-28494)
(cherry picked from commit 9a0dcc5b2e)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2021-09-21 10:53:26 -07:00
Miss Islington (bot)
41e2a31c13
bpo-30637: Improve the docs of ast.parse regarding differences with compile() (GH-28459)
(cherry picked from commit e6d05a4092)

Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
2021-09-19 16:13:56 -07:00
Miss Islington (bot)
6e151ff6fc
[3.9] Fix minor typo in Doc/c-api/type.rst (GH-28432) (GH-28441)
retreived-> retrieved
(cherry picked from commit af08f1ba40)


Co-authored-by: Konstantin Popov <konst.hardy@gmail.com>

Automerge-Triggered-By: GH:Fidget-Spinner
2021-09-17 19:12:25 -07:00
Miss Islington (bot)
eb9833d265
[doc] Clarify exception in multiprocessing.cpu_count (GH-23660) (GH-28434)
Previous wording didn't explain the slightly unintuitive behavior.

Co-authored-by: kj <28750310+Fidget-Spinner@users.noreply.github.com>
(cherry picked from commit 24dbe30f8d)

Co-authored-by: Emmanuel Arias <eamanu@yaerobi.com>
2021-09-18 01:23:38 +02:00
Miss Islington (bot)
6302701179
bpo-42038: fix description of returned list of lines (GH-27529) (GH-28429)
Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2021-09-18 00:56:26 +02:00
Miss Islington (bot)
129e47733b
[doc] Add a missing apostrophe in a code example in venv.rst (GH-28391) (GH-28426)
(cherry picked from commit d22a700091)

Co-authored-by: Arkaprabha Chakraborty <chakrabortyarkaprabha998@gmail.com>
2021-09-18 00:18:19 +02:00
Miss Islington (bot)
3ea1c4b668
bpo-45217: adds note that allow_no_value in configparser is optional (GH-28396) (GH-28416)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit cb07838ab7)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2021-09-17 13:41:25 +02:00
Serhiy Storchaka
9f64b1a44b
[3.9] docs: correct references to __isub__ etc (GH-28297). (GH-28415)
(cherry picked from commit 800bd01b6d)

Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
2021-09-17 14:14:27 +03:00
Miss Islington (bot)
97802a8edb
bpo-45089: Improve sqlite3 trace callback docs (GH-28238) (GH-28372)
- Add link to str object and sqlite3 transaction control
- Mention that exceptions are not propagated
(cherry picked from commit 51056b40e7)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2021-09-15 21:09:27 +02:00
Miss Islington (bot)
baeaaecb8a
bpo-9811: [doc] strftime handling of unsupported format specifiers is platform dependent (GH-28264) (GH-28278)
(cherry picked from commit e86bcfa580)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2021-09-10 21:53:34 +02:00
andrei kulakov
dc2e11ed5a
[3.9] bpo-41082: Add note on errors that may be raised by home() and expanduser() (GH-28186)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-09-08 19:24:09 +02:00