Commit graph

10660 commits

Author SHA1 Message Date
Miss Islington (bot)
f1f54c8fb9
doc: fix a typo in unittest.mock.rst (GH-30227) (GH-30263)
(cherry picked from commit 10bf0a9ac3)

Co-authored-by: Joe <nigelchiang@outlook.com>
2021-12-26 13:51:57 +02:00
Miss Islington (bot)
3c1100fc59
Doc: Fix link in multiprocessing.starmap pointing to builtin map. (GH-26560)
(cherry picked from commit 32096df0e0)

Co-authored-by: Julien Palard <julien@palard.fr>
2021-12-26 03:15:38 -08:00
Miss Islington (bot)
a2295a4029
Update potentially confusing note for mean. (GH-30174) (GH-30221) 2021-12-21 12:44:13 +00:00
Miss Islington (bot)
8e4564d14a
[3.9] bpo-46104: Fix example broken by GH-30148 (GH-30203) (GH-30210)
See discussion in GH-30179.
(cherry picked from commit 7c5c3f7254)


Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

Automerge-Triggered-By: GH:Fidget-Spinner
2021-12-19 22:02:04 -08:00
Miss Islington (bot)
0da17eb069
bpo-46113: Minor fixes in stdtypes documentation (GH-30167) (GH-30187)
* Fix-1 - isidentifier() function output

* Fix-2 Update the str.splitlines() function parameter

* Fix-3 Removed unwanted full stop for str and bytes types double quotes examples.

* Fix-4 Updated class dict from **kwarg to **kwargs
(cherry picked from commit 6f2df42951)

Co-authored-by: Vivek Vashist <vivekvashist@gmail.com>
2021-12-18 22:26:04 +08:00
Miss Islington (bot)
43cb8f483b
[3.9] bpo-46104: Reduce use of pre-PEP 526 syntax in typing docs (GH-30148) (GH-30180)
Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
(cherry picked from commit 6ada013df1)


Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2021-12-18 04:14:19 -08:00
Miss Islington (bot)
4c1effaaee
bpo-28816: [doc] clarify that zipimport invokes importers only for python files (GH-30060) (GH-30134)
(cherry picked from commit a951c95a13)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2021-12-16 12:23:17 +00:00
Miss Islington (bot)
86f9ae53da
Add Positional only arguments forward slash (/) to sorted() function in Built-in Functions document (GH-30113)
sorted() function is missing forward slash (/) in Built-in Functions documentation page.

Automerge-Triggered-By: GH:asvetlov
(cherry picked from commit f025ae63dc)

Co-authored-by: Vivek Vashist <vivekvashist@gmail.com>
2021-12-15 05:00:03 -08:00
Miss Islington (bot)
94234228ab
[3.9] bpo-46063: Improve algorithm for computing which rolled-over log file… (GH-30093) (GH-30095) 2021-12-14 01:19:50 +00:00
Miss Islington (bot)
9b687596df
Clarify new_event_loop return value. (GH-30078) (GH-30089)
(cherry picked from commit e09705f58f)

Co-authored-by: Paul Bryan <pbryan@anode.ca>
2021-12-13 15:25:54 +02:00
Miss Islington (bot)
80eb8ab81f
bpo-37602: Clarify that the lib2to3 nonzero fixer changes only definitions (GH-30075) (GH-30083)
(cherry picked from commit 481f3ffdbe)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2021-12-13 10:45:55 +00:00
Miss Islington (bot)
9299e3a39c
bpo-19737: Improved the documentation for globals (GH-29823) (GH-30042)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 4fe5585240)

Co-authored-by: 180909 <734461790@qq.com>
2021-12-11 01:32:29 +01:00
Miss Islington (bot)
f8eebb0db7
bpo-42114: ctypes documentation: fix winmode parameter default value (GH-29976) (GH-30038)
Signed-off-by: Louis Sautier <sautier.louis@gmail.com>
(cherry picked from commit c1051e08b3)

Co-authored-by: Louis Sautier <sautier.louis@gmail.com>
2021-12-11 00:29:28 +01:00
Miss Islington (bot)
40d765260a
bpo-42182: stdtypes doc - update and fix links to several dunder methods (GH-27384)
(cherry picked from commit 8c74713d0e)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2021-12-10 02:04:54 -08:00
Miss Islington (bot)
db42809d29
bpo-35821: Fix restructuredtext code formatting in logging.rst (GH-29963)
(cherry picked from commit c7e7a4b969)

Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
2021-12-07 07:48:32 -08:00
Miss Islington (bot)
e688568cdf
[3.9] bpo-35821: Add an example to Logger.propagate documentation. (GH-29841) (GH-29958) 2021-12-07 11:45:49 +00:00
Miss Islington (bot)
2e360832d7
bpo-46001: Change OverflowError to RecursionError in JSON library docstrings (GH-29943)
(cherry picked from commit 8db06528ca)

Co-authored-by: James Gerity <snoopjedi@gmail.com>
2021-12-07 02:25:02 -08:00
Miss Islington (bot)
0003d57e22
docs: Improve example for urlparse() (GH-29816) (GH-29889)
(cherry picked from commit 226d22ff2d)

Co-authored-by: Christian Clauss <cclauss@me.com>
2021-12-02 12:24:51 +02:00
Miss Islington (bot)
4203a5d191
bpo-45896: Fix docs default asyncio event loop on Windows (GH-29857) (GH-29878)
(cherry picked from commit f27bef3043)

Co-authored-by: Rob <r4226@pm.me>

Co-authored-by: Rob <r4226@pm.me>
2021-12-01 17:40:50 +02:00
Miss Islington (bot)
031e2bb332
bpo-33381: [doc] strftime's %f option may pad zeros on the left or the right (GH-29801) (GH-29863)
(cherry picked from commit f97ec09baf)

Co-authored-by: Vishal Pandey <vishalpandeyviptsk@gmail.com>
2021-11-30 11:50:28 +00:00
Miss Islington (bot)
376b24e4f6
bpo-43905: Expand dataclasses.astuple() and asdict() docs (GH-26154)
Expanded ``astuple()`` docs, warning about deepcopy being applied
and providing a workaround.

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

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2021-11-29 10:30:38 -08:00
Miss Islington (bot)
151c9bf649
bpo-45693: Document port parameter to loop.create_server (GH-29760) (GH-29763)
Document the `port` parameter to `loop.create_server` in `asyncio`. In
particular, note that if `host` resolves to multiple network interfaces,
passing in `port=0` will result in a different random unused port being
used for each interface.

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

Co-authored-by: Jim Crist-Harif <jcristharif@gmail.com>

Co-authored-by: Jim Crist-Harif <jcristharif@gmail.com>
2021-11-24 15:40:09 -05:00
Miss Islington (bot)
c06c7c489a
[3.9] bpo-45788: Link sys.prefix doc to 'Installation paths' (GH-29606) (GH-29632)
... To the Installation paths section of the sysconfig doc.
(cherry picked from commit 4575c01b75)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-11-18 16:45:15 -05:00
Miss Islington (bot)
591bf41609
[3.9] [doc] bpo-45680: Disambiguate `__getitem__ and __class_getitem__` in the data model (GH-29389) (GH-29619)
The documentation explaining Python's data model does not adequately explain
the differences between ``__getitem__`` and ``__class_getitem__``, nor does it
explain when each is called. There is an attempt at explaining
``__class_getitem__`` in the documentation for ``GenericAlias`` objects, but
this does not give sufficient clarity into how the method works. Moreover, it
is the wrong place for that information to be found; the explanation of
``__class_getitem__`` should be in the documentation explaining the data model.

This PR has been split off from GH-29335.
(cherry picked from commit 31b3a70edb)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-11-18 18:41:09 +01:00
Ethan Furman
feccea6a7e
[3.9] [Enum] update member.member removal (GH-29611)
Accessing one enum member from another originally raised an `AttributeError`, but became possible due to a performance boost implementation detail.  In 3.11 it will again raise an `AttributeError`.
2021-11-18 00:50:42 -08:00
Miss Islington (bot)
17f5c5cad3
[docs] Add missing word "any" in unittest -k cmdline option description (GH-29571) (GH-29604)
(cherry picked from commit abc0d754c3)

Co-authored-by: ch33zer <ch33zer@gmail.com>
2021-11-18 01:26:12 +01:00
Miss Islington (bot)
fd206b6807
[3.9] Save a reference for ensure_future and create_task (GH-29163) (GH-29573)
Co-authored-by: Joannah Nanjekye <jnanjekye@python.org>
(cherry picked from commit c750adbe69)


Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>

Automerge-Triggered-By: GH:asvetlov
2021-11-16 03:47:02 -08:00
Miss Islington (bot)
a40d066e8e
bpo-45677: Reword first section of sqlite3 docs (GH-29326) (GH-29567)
* bpo-45677: Avoid addressing the reader as 'you' in sqlite3 docs

* Adjust wording

* Adjust wording again

* Typo

* Update Doc/library/sqlite3.rst

Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>

* Address review: adjust wording

* Update Doc/library/sqlite3.rst

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Update Lib/sqlite3/__init__.py

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Update Doc/library/sqlite3.rst

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Update Doc/library/sqlite3.rst

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Update Lib/sqlite3/__init__.py

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Update Doc/library/sqlite3.rst

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Apply Alex' suggestion, and apply 80 char limit to PR

* Minor adjustment

Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 6c5a312fb6)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2021-11-15 15:32:31 -08:00
Miss Islington (bot)
6073920fcd
bpo-45752: Fix no-support examples in 'copy' docs (GH-29548)
(cherry picked from commit b7360ae395)

Co-authored-by: M. Mostafa Farzan <m2_farzan@yahoo.com>
2021-11-14 01:58:01 -08:00
Miss Islington (bot)
b952f60213
[3.9] bpo-45772: socket.socket should be a class instead of a function (GH-23960) (GH-29543)
* [bpo-45772](): socket.socket should be a class instead of a function

Currently `socket.socket` is documented as a function, but it is really
a class (and thus has function-like usage to construct an object). This
correction would ensure that Python projects that are interlinking
Python's documentation can properly locate `socket.socket` as a type.
(cherry picked from commit 4c792f39e6)


Co-authored-by: Hong Xu <hong@topbug.net>

Automerge-Triggered-By: GH:asvetlov
2021-11-12 22:29:01 -08:00
Miss Islington (bot)
8b6a474071
bpo-45792: Fix contextvar.Token's intersphinx FQN (GH-29533) (GH-29536)
Since `.. module:: contextvars` sets the module using `.. class:: contextvars.Token`, intersphinx records it as `contextvars.contextvars.Token`.
(cherry picked from commit e501d70b34)

Co-authored-by: Hynek Schlawack <hs@ox.cx>

Co-authored-by: Hynek Schlawack <hs@ox.cx>
2021-11-12 12:20:20 +02:00
Miss Islington (bot)
a8ae7a5613
bpo-45762: Improve docs for `@singledispatch/@singledispatchmethod` (GH-29426) (GH-29430)
(cherry picked from commit 71e8a3e76a)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2021-11-05 17:52:14 +01:00
Miss Islington (bot)
7e244fc804
Remove reference to `Tuple at top of typing` docs (GH-29401)
``typing.Tuple`` has been deprecated since Python 3.9, so it makes no sense to mention it so prominently in the documentation for the ``typing`` module.
(cherry picked from commit 87032cfa3d)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2021-11-04 05:13:24 -07:00
Miss Islington (bot)
e813dd4d7b
bpo-45680: `typing docs: improve links to docs on GenericAlias/__class_getitem__` (GH-29387)
(cherry picked from commit e03e50377d)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2021-11-03 21:34:31 -07:00
Miss Islington (bot)
d3e7755015
[doc] Link to section File input (GH-28941) (GH-29376)
(cherry picked from commit 48824fa1e2)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2021-11-02 22:59:42 +01:00
Miss Islington (bot)
4ab6e524ab
bpo-45457: Minor fix to documentation for SSLContext.load_default_certs. (GH-28947) (GH-29374)
Specify that SSLContext.set_default_verify_paths is called on ALL systems.

The code of SSLContext.load_default_certs was changed in bpo-22449 to do this,
this fix corrects the documentation to match that change.
(cherry picked from commit 3551bf16ee)

Co-authored-by: LincolnPuzey <lincoln@puzey.dev>
2021-11-02 22:53:45 +01:00
Miss Islington (bot)
da04bef5f7
[3.9] Move field width to the right field (GH-29344) (GH-29350)
Co-authored-by: Olaf van der Spek <olafvdspek@gmail.com>
2021-10-31 20:25:21 +00:00
Miss Islington (bot)
b04b307e0e
bpo-45516: add protocol description to the Traversable documentation (GH-29039)
* bpo-45516: add protocol description to the Traversable documentation

Signed-off-by: Filipe Laíns <lains@riseup.net>

* Update Doc/library/importlib.rst

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>

* Update Lib/importlib/abc.py

* Update Doc/library/importlib.rst

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
(cherry picked from commit 4d03de3329)

Co-authored-by: Filipe Laíns <filipe.lains@gmail.com>
2021-10-31 12:27:49 -07:00
Miss Islington (bot)
3ec1124de2
bpo-45600: Enhanced / clarified the docs for os.environ and os.environb (GH-29204) (GH-29321)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit b17cfd150f)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2021-10-29 22:52:59 +02:00
Miss Islington (bot)
e1560313d4
bpo-45335: Add note to sqlite3 docs about "timestamp" converter (GH-29200) (GH-29320)
(cherry picked from commit 3877fc02f7)

Co-authored-by: Ian Fisher <ian@iafisher.com>
2021-10-29 22:42:38 +02:00
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)
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)
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
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