Commit graph

11023 commits

Author SHA1 Message Date
Terry Jan Reedy
5603db43ba
[3.10] bpo-46609: Update asyncio-task coroutine doc (GH-31132)
@coroutine in removed in 3.11, not 3.10.
2022-02-04 14:59:23 -05:00
Miss Islington (bot)
34895f694c
Optimize images by IMGbot (GH-21348)
Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>
(cherry picked from commit ba650af7d6)
2022-02-04 16:31:21 +09:00
Raymond Hettinger
a77de58108
Add recipe for subslices (GH-31095) 2022-02-03 02:12:08 -06:00
Miss Islington (bot)
e480def027
Fix minor details in the Counter docs (GH-31029) (GH-31072) 2022-02-01 23:28:07 -06:00
Miss Islington (bot)
2572c670d4
[3.10] bpo-23556: [doc] Fix inaccuracy in documentation for raise without args. Improve tests for context in nested except handlers. (GH-29236) (GH-30953)
(cherry picked from commit 08c0ed2d9c)


Co-authored-by: Kinshuk Dua <kinshukdua@gmail.com>

Automerge-Triggered-By: GH:iritkatriel
2022-01-27 02:51:06 -08:00
Miss Islington (bot)
1ecc98dedb
bpo-42982: Improve the text on suggested number of iterations of PBKDF2 (GH-24276)
Less specific number wording (as there is no one right number - the old 100k is too big for some applications and woefully small for others). We now link to NIST SP 800-132 to tell people what to read in there on how to decide for their application.

Co-authored-by: Gregory P. Smith <greg@krypto.org> [Google]
(cherry picked from commit 897ce90187)

Co-authored-by: Illia Volochii <illia.volochii@gmail.com>
2022-01-27 01:01:30 -08:00
Miss Islington (bot)
5acaad0b30
bpo-45296: Clarify close, quit, and exit in IDLE (GH-30936) (GH-30944)
In the File menu, 'Close' and 'Exit' are now 'Close Window' (the current
one) and 'Exit' is now 'Exit IDLE' (by closing all windows).
In Shell, 'quit()' and 'exit()' mean 'close Shell'.
If there are no other windows, this also exits IDLE.
(cherry picked from commit fcde0bc10d)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-01-26 22:55:25 -05:00
Miss Islington (bot)
a57ec7a4fe
bpo-43698: do not use ... as argument name in docs (GH-30502)
(cherry picked from commit b9d8980d89)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2022-01-26 04:42:26 -08:00
Miss Islington (bot)
b2c7fe1f61
Improve grouper() recipe to demonstrate all forms of zip() (GH-30837) (GH-30840) 2022-01-23 16:02:31 -06:00
Miss Islington (bot)
f66ef3eab6
bpo-46266: Add calendar day of week constants to __all__ (GH-30412) (GH-30424)
(cherry picked from commit e5894ca8fd)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2022-01-23 02:00:11 +01:00
Miss Islington (bot)
923c994400
bpo-46468: document that "-m http.server" defaults to port 8000 (GH-30776) (#30787)
Code link:
70c16468de/Lib/http/server.pyGH-L1270

It's been this way since at least 3.4.

Also improved some wording in the same section.
(cherry picked from commit c8a536624e)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-01-22 17:31:52 +02:00
Miss Islington (bot)
ee07750088
doc: Clarify os.urandom return type (GH-30282)
Other descriptions in the same file also use 'bytestring' to refer to bytes objects
(cherry picked from commit 4b99803b86)

Co-authored-by: Florian Bruhin <me@the-compiler.org>
2022-01-19 13:58:13 -08:00
Miss Islington (bot)
c4fe0aa670
Update documentation in datetime module strftime-and-strptime-behavior fix typo in '%W' format code description (GH-30232)
A small change to the documentation of datetime module , in the format codes section of stftime and strptime. Changed the description of format code '%W' from 'as a decimal number' to 'a zero padded   decimal number' so it's in line with the example having leading zeros.  Similar to the format code '%U' above.

Automerge-Triggered-By: GH:pganssle
(cherry picked from commit d45cd2d207)

Co-authored-by: Evan <binary-signal@users.noreply.github.com>
2022-01-19 10:02:07 -08:00
Miss Islington (bot)
24d0b331e8
[3.10] bpo-45680: Clarify documentation on `GenericAlias` objects (GH-29335) (GH-30688)
The documentation on ``GenericAlias`` objects implies at multiple points that
only container classes can define ``__class_getitem__``. This is misleading.
This PR proposes a rewrite of the documentation to clarify that non-container
classes can define ``__class_getitem__``, and to clarify what it means when a
non-container class is parameterized.

See also: initial discussion of issues with this piece of documentation in
GH-29308, and previous BPO issue [42280]().

Also improved references in glossary and typing docs. Fixed some links.

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
(cherry picked from commit 0eae9a2a2d)


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

Automerge-Triggered-By: GH:Fidget-Spinner
2022-01-19 07:24:14 -08:00
Erlend Egeberg Aasland
01e6cbefd3
[3.10] bpo-46402: Promote SQLite URI tricks in sqlite3 docs (GH-30660) (GH-30671)
* bpo-46402: Promote SQLite URI tricks in `sqlite3` docs (GH-30660)

Provide some examples of URI parameters in sqlite connect().

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
(cherry picked from commit bdf2ab1887)

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

* Update suspicious rules
2022-01-18 16:57:33 -05:00
Miss Islington (bot)
4449a1694a
bpo-45554: Document multiprocessing.Process.exitcode values (GH-30142)
This addresses [bpo-45554]() by expanding the `exitcode` documentation to also describe what `exitcode` will be in cases of normal termination, `sys.exit()` called, and on uncaught exceptions.

Automerge-Triggered-By: GH:pitrou
(cherry picked from commit 3852269b91)

Co-authored-by: John Marshall <jmarshall@hey.com>
2022-01-18 13:51:30 -08:00
Miss Islington (bot)
9238a52cbc
bpo-20823: Clarify copyreg.pickle() documentation (GH-30230)
(cherry picked from commit 65940fa5c1)

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-01-18 12:16:54 -08:00
Miss Islington (bot)
93dc1654dc
bpo-20281, bpo-29964: update datetime docs to refer %z and %Z to a pre-existing footnote (GH-30354)
(cherry picked from commit 305588c67c)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-01-14 15:59:20 -08:00
Miss Islington (bot)
26039d1e0a
bpo-23183: Document the timeit output (GH-30359)
Co-authored-by: Robert Collins <robertc@robertcollins.net>
(cherry picked from commit 73140de97c)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-01-14 09:47:51 -08:00
Miss Islington (bot)
3ce6945f5f
Define Py_BUILD_CORE_MODULE 2022-01-13 01:42:47 -08:00
Miss Islington (bot)
da8c0759d2
Remove unused Any from Concatenate example in typing docs (GH-30516)
(cherry picked from commit 73decdf021)

Co-authored-by: Michael Oliver <michaeloliver__@outlook.com>
2022-01-11 06:21:40 -08:00
Miss Islington (bot)
987fba102e
bpo-46261: Update sqlite3.Cursor.lastrowid docs (GH-30407) 2022-01-08 22:05:43 +02:00
Miss Islington (bot)
8bef658668
bpo-46290: Fix parameter names in dataclasses docs (GH-30450)
(cherry picked from commit ef5376e69e)

Co-authored-by: Zsolt Dollenstein <zsol.zsol@gmail.com>
2022-01-08 07:09:40 -08:00
Miss Islington (bot)
e35430bec5
[3.10] bpo-42378: fixed log truncation on logging shutdown (GH-27310) (GH-30468)
Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2022-01-07 22:15:25 +00:00
Miss Islington (bot)
ed2656a7d3
bpo-28546: [doc] Clarify setting pdb breakpoints (GH-30360)
Co-authored-by: Ian Kelling <ian@iankelling.org>
(cherry picked from commit 6d07a9fb7c)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-01-07 12:03:36 -08:00
Miss Islington (bot)
6630952cf0
bpo-46216: remove spurious link to os.system() from os.time() documentation (GH-30326)
Automerge-Triggered-By: GH:iritkatriel
(cherry picked from commit 9b7aa6a9d6)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-01-07 10:50:09 -08:00
Miss Islington (bot)
db60ed1170
[3.10] bpo-46251: Add 'Security Considerations' section to logging configura… (GH-30411) (GH-30447) 2022-01-06 23:18:41 +00:00
Miss Islington (bot)
289a32baf7
Fix missing "," in the documentation of Executor Objects (GH-30404)
(cherry picked from commit f404e26d74)

Co-authored-by: Philipp Claßen <philipp.classen@posteo.de>

Co-authored-by: Philipp Claßen <philipp.classen@posteo.de>
2022-01-04 11:17:16 -08:00
Miss Islington (bot)
ba124672d7
bpo-20369: concurrent.futures.wait() now deduplicates futures given a… (GH-30168)
* bpo-20369: concurrent.futures.wait() now deduplicates futures given as arg.

* 📜🤖 Added by blurb_it.

Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
(cherry picked from commit 7d7817cf0f)

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-01-04 06:27:13 -08:00
Miss Islington (bot)
01b12942d0
bpo-33252: Document that ResourceWarning is ignored by default (GH-30358) (GH-30395)
`ResourceWarning` is ignored by default.

Document this behaviour, for consistency with others in this table such as `DeprecationWarning`.

Documentation PR can skip NEWS file.

Automerge-Triggered-By: GH:iritkatriel
(cherry picked from commit b949845b36)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-01-04 12:03:38 +00:00
Miss Islington (bot)
685b6285b9
Add doctest and improve readability for move_to_end() example. (GH-30370) (GH-30373) 2022-01-03 21:55:38 -08:00
Miss Islington (bot)
8184a613b9
bpo-34931: [doc] clarify behavior of os.path.splitext() on paths with multiple leading periods (GH-30347) (GH-30368)
(cherry picked from commit 51700bf08b)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-01-03 20:36:41 +00:00
Miss Islington (bot)
74af713538
argparse docs: prog default is the basename of argv[0] (GH-30298) (GH-30339) 2022-01-02 13:29:35 -08:00
Miss Islington (bot)
e9783d6434
bpo-46095: Improve SeqIter documentation. (GH-30316) (GH-30330) 2022-01-01 11:12:43 -08:00
Miss Islington (bot)
ed1671ced7
[3.10] bpo-46120: State that | is preferred over Union (GH-30222) (GH-30250)
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
(cherry picked from commit 1b30660c3b)


Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

Automerge-Triggered-By: GH:gpshead
2021-12-29 03:45:14 -08:00
Miss Islington (bot)
a55082085c
Fix typo in io.rst (GH-30218)
(cherry picked from commit f9a4352056)

Co-authored-by: David Gilbertson <gilbertson.david@gmail.com>
2021-12-26 03:52:46 -08:00
Miss Islington (bot)
cfdb2302f4
doc: fix a typo in unittest.mock.rst (GH-30227)
(cherry picked from commit 10bf0a9ac3)

Co-authored-by: Joe <nigelchiang@outlook.com>
2021-12-26 03:51:42 -08:00
Miss Islington (bot)
2cb9ed2a6a
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:14 -08:00
Miss Islington (bot)
989d2371c8
Update potentially confusing note for mean. (GH-30174) (GH-30220)
(cherry picked from commit e9a01e231a)
2021-12-21 14:15:39 +00:00
Miss Islington (bot)
0c0bd78ccf
[3.10] bpo-46104: Fix example broken by GH-30148 (GH-30203) (GH-30209)
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:01:51 -08:00
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)
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)
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)
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
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)
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