Commit graph

24495 commits

Author SHA1 Message Date
Miss Islington (bot)
bb286d45af
bpo-46113: Minor fixes in stdtypes documentation (GH-30167) (GH-30186)
* 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:12:30 +08:00
Miss Islington (bot)
a66be9185c
[3.10] bpo-46104: Reduce use of pre-PEP 526 syntax in typing docs (GH-30148) (GH-30179)
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:25 -08:00
Miss Islington (bot)
dbd1dc23f6
[3.10] bpo-46044: Annotate deprecated sdists formats (GH-30043) (#30154)
(cherry picked from commit ecdc0ccede)

Co-authored-by: Matthias Bussonnier <bussonniermatthias@gmail.com>
Co-authored-by: Brett Cannon <brett@python.org>
Co-authored-by: Éric <merwok@netwok.org>
2021-12-17 15:32:02 -08:00
Miss Islington (bot)
0194bbbee6
bpo-28816: [doc] clarify that zipimport invokes importers only for python files (GH-30060) (GH-30133)
(cherry picked from commit a951c95a13)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2021-12-16 12:23:41 +00:00
Miss Islington (bot)
fb5d314da8
Fix the output of built-in iter() function example in Iterators (Section 9.8) of The Python Tutorial (GH-30110)
Updated the output for it=iter(s) from <iterator object at 0x00A1DB50> to <str_iterator object at 0x10c90e650>
(cherry picked from commit c5d18a5014)

Co-authored-by: Vivek Vashist <vivekvashist@gmail.com>
2021-12-16 03:00:58 -08:00
Miss Islington (bot)
c8044777cf
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 04:59:01 -08:00
Miss Islington (bot)
503803d8c1
bpo-46059: Clarify pattern-matching example in "control flow" docs (GH-30079)
The "Color" example in the pattern-matching section of the "control flow" documentation is not immediately runnable, leading to confusion.

Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
(cherry picked from commit 1cbb88736c)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2021-12-14 07:25:32 -08:00
Miss Islington (bot)
f84e2f6c0a
[3.10] bpo-46063: Improve algorithm for computing which rolled-over log file… (GH-30093) (GH-30094)
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2021-12-14 01:17:56 +00:00
Miss Islington (bot)
bcb5d66b8f
Clarify new_event_loop return value. (GH-30078) (GH-30088)
(cherry picked from commit e09705f58f)

Co-authored-by: Paul Bryan <pbryan@anode.ca>
2021-12-13 15:24:50 +02:00
Irit Katriel
310bae628a
[3.10] bpo-37602: Clarify that the lib2to3 nonzero fixer changes only definitions (GH-30075) (GH-30085)
(cherry picked from commit 481f3ffdbe)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2021-12-13 10:47:38 +00:00
Alex Waygood
7da90251ae
bpo-45840: Improve cross-references in the data model documentation (GH-29633) (GH-30077)
(cherry picked from commit c0521fe49f)
2021-12-13 11:20:21 +02:00
Miss Islington (bot)
438817fdd5
bpo-46042: Improve SyntaxError locations in the symbol table (GH-30059) (GH-30064)
(cherry picked from commit 59435eea08)

Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>

Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
2021-12-12 01:24:12 +00:00
Andrew Svetlov
991736697d
[3.10] bpo-46040: Fix removal text for @asyncio.coroutine (GH-30061) 2021-12-11 20:27:47 +02:00
Miss Islington (bot)
1f7000808e
bpo-19737: Improved the documentation for globals (GH-29823) (GH-30041)
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:13 +01:00
Miss Islington (bot)
0f21bac6ce
Fix markup buglet in Doc/howto/annotations.rst (GH-29802) (GH-29805)
(cherry picked from commit 94daf39b2f)

Co-authored-by: Guido van Rossum <guido@python.org>
2021-12-11 01:03:55 +01:00
Miss Islington (bot)
4b224e8729
[doc] Clarify MRO precedence in descriptor super binding section (GH-29539) (GH-29669)
A similar sentence is present in the 'Invocation from super' section of
the descriptor HOWTO, where it is already correct.
(cherry picked from commit ee49484c0f)

Co-authored-by: Jouke Witteveen <j.witteveen@gmail.com>
2021-12-11 01:01:16 +01:00
Miss Islington (bot)
8f3728edcb
bpo-42114: ctypes documentation: fix winmode parameter default value (GH-29976) (GH-30037)
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:46 +01:00
Miss Islington (bot)
64c2788f42
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:02:14 -08:00
Miss Islington (bot)
2c2ee83c4d
bpo-45391: mark UnionType as a class in documentation (GH-28757)
Signed-off-by: Bernát Gábor <bgabor8@bloomberg.net>
(cherry picked from commit e2cfc89e09)

Co-authored-by: Bernát Gábor <gaborjbernat@gmail.com>
2021-12-09 05:17:36 -08:00
Mark Shannon
99c72326d2
[3.10] bpo-46009: Do not exhaust generator when send() method raises (GH-29986). (GH-29988)
* [3.10] bpo-46009: Do not exhaust generator when send() method raises (GH-29986).
(cherry picked from commit 69806b9516)

Co-authored-by: Mark Shannon <mark@hotpy.org>

* Rename variable after cherry-pick.

* Add NULL check.
2021-12-08 14:46:32 +00:00
Miss Islington (bot)
cca3004f64
doc: Add link issue 44010 (GH-29454)
(cherry picked from commit 3e0f13b9e4)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2021-12-08 03:18:33 -08:00
Miss Islington (bot)
14f03ce6e8
[3.10] bpo-35821: Fix restructuredtext code formatting in logging.rst (GH-29963) (GH-29965)
(cherry picked from commit c7e7a4b969)


Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>

Automerge-Triggered-By: GH:Fidget-Spinner
2021-12-07 07:47:31 -08:00
Miss Islington (bot)
f78c229b4e
[3.10] bpo-35821: Add an example to Logger.propagate documentation. (GH-29841) (GH-29957) 2021-12-07 11:45:13 +00:00
Miss Islington (bot)
15da2a2723
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:20:10 -08:00
Miss Islington (bot)
f6648e229e
bpo-45916: Use HTTPS link for The Perils of Floating Point (GH-29896)
(cherry picked from commit 9f2f7e4226)

Co-authored-by: Zachary Ware <zach@python.org>
2021-12-02 12:45:09 -08:00
Miss Islington (bot)
eac07e5ab0
docs: Improve example for urlparse() (GH-29816) (GH-29888)
(cherry picked from commit 226d22ff2d)

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

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

Co-authored-by: Vishal Pandey <vishalpandeyviptsk@gmail.com>
2021-11-30 11:49:59 +00:00
Miss Islington (bot)
32f1491a97
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:32:56 -08:00
Miss Islington (bot)
efe2a2306b
[3.10] [Doc] Add info to logging cookbook about running logging socket listeners i… (GH-29838) (GH-29839) 2021-11-29 13:28:05 +00:00
Miss Islington (bot)
7842aed7a7
bpo-45619: documentation of execution model: clarify and update binding summary (GH-29232)
This does two changes that are quite related.

0. it add that variable binding can occur in pattern matching, an update of 3.10
which seems to have been omitted from the list of bindings
1. Given how long the sentence already was, with even subcases in the middle of
the sentence, the commit breaks the sentence into an actual list.
(cherry picked from commit cd876c8493)

Co-authored-by: Arthur Milchior <arthur@milchior.fr>
2021-11-25 21:36:37 -08:00
Andrew Svetlov
52d10f6485
[3.10] bpo-45568: Actually use @asynccontextmanager in usage example (GH-29151) (GH-29779)
Automerge-Triggered-By: GH:asvetlov
(cherry picked from commit 4dd82194f4)

Co-authored-by: Zbigniew Siciarz <zbigniew@siciarz.net>

Co-authored-by: Zbigniew Siciarz <zbigniew@siciarz.net>
2021-11-25 19:20:17 +02:00
Miss Islington (bot)
8cabcde8d6
bpo-45693: Document port parameter to loop.create_server (GH-29760) (GH-29762)
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:39:51 -05:00
Brett Cannon
99aad31b7a
[3.10] bpo-45250: fix docs regarding __iter__ and iterators being inconsistently required by CPython (GH-29170) (GH-29650)
It is now considered a historical accident that e.g. `for` loops and the `iter()` built-in function do not require the iterators they work with to define `__iter__`, only `__next__`.
(cherry picked from commit be36e06340)

Co-authored-by: Brett Cannon <brett@python.org>
2021-11-22 15:09:15 -08:00
Miss Islington (bot)
3528df1258
[3.10] bpo-45845: Change link for pyserial (GH-29675)
(cherry picked from commit 123a3527dd)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-11-20 15:51:24 -05:00
Miss Islington (bot)
edabf39046
bpo-45845: Remove unresponsive web link (GH-29651) (GH-29674)
Threading notes by Aahz from OSCON 2001.

(cherry picked from commit 9852339145)
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-11-20 13:50:24 -05:00
Miss Islington (bot)
82f1a6edfb
bpo-45846: Fix capitalisation of Van Rossum at the start of sentence (GH-29641) (GH-29656)
(cherry picked from commit bc2bc0dbdb)

Co-authored-by: JMcB <joel.mcbride1@live.com>
2021-11-20 16:57:16 +01:00
Miss Islington (bot)
bbe3c57c86
bpo-19072: Classmethod can wrap other classmethod like descriptors (GH-29634) (GH-29643)
staticmethod() also became callable in Python 3.10.

See: b83861f02.
(cherry picked from commit e34809e1c2)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2021-11-19 20:12:16 +01:00
Miss Islington (bot)
2a630e716e
[3.10] bpo-45788: Link sys.prefix doc to 'Installation paths' (GH-29606)
... 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:46:06 -05:00
Miss Islington (bot)
fde9f61e70
[3.10] [doc] bpo-45680: Disambiguate `__getitem__ and __class_getitem__` in the data model (GH-29389) (GH-29620)
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:34:08 +01:00
Miss Islington (bot)
252d83cbf1
bpo-45640: [docs] Tokens are now clickable (GH-29260) (GH-29621)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 32959108f9)

Co-authored-by: Arthur Milchior <arthur@milchior.fr>
2021-11-18 17:28:39 +01:00
Miss Islington (bot)
02531f1d7e
[doc] Expand on soft keywords in the docs for keyword.py (GH-29139) (GH-29195)
Add link at the top and fix the existing links to point to the "[soft keywords](https://docs.python.org/3.10/reference/lexical_analysis.htmlGH-soft-keywords)" section created in the Python 3.10 docs.

(cherry picked from commit 9e05da6224)

Co-authored-by: William Andrea <william.j.andrea@gmail.com>
2021-11-18 17:23:03 +01:00
Miss Islington (bot)
0df5d31ac7
bpo-45701: Improve documentation for *typed* parameter (GH-29498) (GH-29509)
(cherry picked from commit 912a4ccc3a)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2021-11-18 17:12:07 +01:00
Ethan Furman
65c089751b
[3.10] [Enum] update member.member removal (GH-29608)
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-17 23:38:56 -08:00
Miss Islington (bot)
563e45875a
[docs] Add missing word "any" in unittest -k cmdline option description (GH-29571) (GH-29603)
(cherry picked from commit abc0d754c3)

Co-authored-by: ch33zer <ch33zer@gmail.com>
2021-11-18 01:25:54 +01:00
Miss Islington (bot)
7bac598819
Save a reference for ensure_future and create_task (GH-29163)
Co-authored-by: Joannah Nanjekye <jnanjekye@python.org>
(cherry picked from commit c750adbe69)

Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
2021-11-16 03:51:19 -08:00
Miss Islington (bot)
94dad5e41e
bpo-45677: Reword first section of sqlite3 docs (GH-29326) (GH-29566)
* 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:31:38 -08:00
Miss Islington (bot)
0320cf1a25
bpo-25381: Update explanation of exceptions in C. (GH-26838) (GH-29568)
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

(cherry picked from commit ad43dc0b54)
2021-11-15 18:06:45 -05:00
M. Mostafa Farzan
2081f9fe75
[3.10] bpo-45752: Fix no-support examples in 'copy' docs (GH-29548) (GH-29556)
(cherry picked from commit b7360ae395)

Co-authored-by: M. Mostafa Farzan <m2_farzan@yahoo.com>

Automerge-Triggered-By: GH:asvetlov
2021-11-14 04:54:42 -08:00
Miss Islington (bot)
28326ac5f8
bpo-45799: [Doc] improve confusing sentence in __main__.rst (GH-29546)
I was reading this bit last night and thought it was a typo. In the light of day, I realized it wasn't *technically* a typo, but definitely confusing wording. This PR fixes the confusing sentence.

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

Co-authored-by: Jack DeVries <jdevries3133@gmail.com>
2021-11-13 12:36:44 -08:00