Commit graph

23950 commits

Author SHA1 Message Date
Miss Islington (bot)
d0852c447a
Update documentation in datetime module strftime-and-strptime-behavior fix typo in '%W' format code description (GH-30232) (GH-30703)
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>

Co-authored-by: Evan <binary-signal@users.noreply.github.com>
2022-01-23 01:59:41 +01:00
Miss Islington (bot)
d807bf2ee9
Document optional 'task'/'asyncgen' fields in call_exception_handler (GH-21735) (GH-30727)
(cherry picked from commit a1652da2c8)

Co-authored-by: Shane Harvey <shnhrv@gmail.com>

Co-authored-by: Shane Harvey <shnhrv@gmail.com>
2022-01-23 01:59:23 +01:00
Miss Islington (bot)
b4088801db
bpo-46468: document that "-m http.server" defaults to port 8000 (GH-30776) (#30786)
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:40 +02:00
Miss Islington (bot)
b37f3e993a
bpo-46463: Fixes escape4chm.py script used when building the CHM documentation file (GH-30768)
(cherry picked from commit 57d1855682)

Co-authored-by: Steve Dower <steve.dower@python.org>
2022-01-21 14:15:44 -08:00
Miss Islington (bot)
981c1dc8b6
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 14:07:47 -08:00
Ken Jin
00645166b6
[3.9] bpo-45680: Clarify documentation on `GenericAlias` objects (GH-29335) (GH-30689)
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](https://bugs.python.org/issue42280).

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

(cherry picked from commit 0eae9a2a2d)

Co-Authored-By: Erlend Egeberg Aasland <erlend.aasland@innova.no>
Co-Authored-By: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
Co-Authored-By: Alex Waygood <Alex.Waygood@Gmail.com>
2022-01-20 00:01:30 +08:00
Miss Islington (bot)
353674f289
bpo-46231: Remove invalid_* rules preceded by more tokens from the grammar docs (GH-30341) (GH-30392)
(cherry picked from commit e09d94a140)

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

Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
2022-01-19 14:45:50 +00:00
Miss Islington (bot)
7b694b816f
[3.9] bpo-22039: [doc] clarify that there are no plans to disable deleting an attribute via PyObject_SetAttr (GH-30639) (GH-30685)
(cherry picked from commit 3bf6315c4c)


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

Automerge-Triggered-By: GH:iritkatriel
2022-01-19 04:29:52 -08:00
Miss Islington (bot)
0be4760d85
[3.9] bpo-45554: Document multiprocessing.Process.exitcode values (GH-30142) (GH-30675)
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.


(cherry picked from commit 3852269b91)


Co-authored-by: John Marshall <jmarshall@hey.com>
2022-01-18 14:03:22 -08:00
Erlend Egeberg Aasland
0ae2257760
[3.9] bpo-46402: Promote SQLite URI tricks in sqlite3 docs (GH-30660) (#30672)
* 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:58:47 -05:00
Miss Islington (bot)
8527f7a722
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:17:06 -08:00
Miss Islington (bot)
f869b56fe4
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:56 -08:00
Miss Islington (bot)
9badf6895a
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:53:38 -08:00
Christian Heimes
4ddd5da269
[3.9] bpo-40479: Fix hashlib's usedforsecurity for OpenSSL 3.0.0 (GH-30455) (GH-30574)
Co-authored-by: Christian Heimes <christian@python.org>
2022-01-13 11:20:45 +01:00
Miss Islington (bot)
12cf91c3b1
[doc] Add license_url for python-docs-theme 2022.1. (GH-30527) (GH-30541)
(cherry picked from commit 6f05e1ec19)

Co-authored-by: Julien Palard <julien@palard.fr>

Co-authored-by: Julien Palard <julien@palard.fr>
2022-01-11 21:18:45 +01:00
Miss Islington (bot)
238a36b753
closes bpo-46253: Change Py_UNICODE to Py_UCS4 in the C API docs to match the current source code (GH-30387)
(cherry picked from commit 43c5c1369c)

Co-authored-by: Julian Gilbey <julian-git@d-and-j.net>
2022-01-11 06:59:26 -08:00
Miss Islington (bot)
b29aa71090
[3.9] bpo-46261: Update sqlite3.Cursor.lastrowid docs (GH-30407) 2022-01-08 22:06:14 +02:00
Miss Islington (bot)
cd95033d9c
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:58 -08:00
Miss Islington (bot)
a74eb54655
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:06:43 -08:00
Miss Islington (bot)
c55616cf93
bpo-46216: remove spurious link to os.system() from os.time() documentation (GH-30326) (GH-30460)
Automerge-Triggered-By: GH:iritkatriel
(cherry picked from commit 9b7aa6a9d6)

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

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-01-07 19:01:26 +00:00
Miss Islington (bot)
8bc68140cb
bpo-24650: Use full term "generator function" in yield expressions docs (GH-24663)
(cherry picked from commit 273cb8e757)

Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
2022-01-07 11:00:45 -08:00
Miss Islington (bot)
188fbdee0d
[3.9] bpo-46251: Add 'Security Considerations' section to logging configura… (GH-30411) (GH-30448) 2022-01-06 23:18:18 +00:00
Miss Islington (bot)
f902d88be3
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:15:56 -08:00
Miss Islington (bot)
9a9061d1ca
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:26 -08:00
Miss Islington (bot)
8f082e2bf4
bpo-33252: Document that ResourceWarning is ignored by default (GH-30358) (GH-30396)
`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:58 +00:00
Miss Islington (bot)
4affb996ce
bpo-34538: Remove Exception subclassing from tutorial (GH-30361)
Remove the bit about subclassing exceptions.

Documentation PR can skip the NEWS label.

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

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-01-03 15:19:29 -08:00
Miss Islington (bot)
4a792ca95c
bpo-34931: [doc] clarify behavior of os.path.splitext() on paths with multiple leading periods (GH-30347) (GH-30369)
(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:39:02 +00:00
Miss Islington (bot)
b28b0222e3
bpo-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969) (GH-30343)
(cherry picked from commit ee2549c2ba)

Co-authored-by: Julien Palard <julien@palard.fr>
2022-01-02 18:04:33 -05:00
Miss Islington (bot)
17c858e331
Update copyright year to 2022. (GH-30335)
Automerge-Triggered-By: GH:benjaminp
(cherry picked from commit ba00f0d93a)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2022-01-02 12:34:36 -08:00
Miss Islington (bot)
72ffcb02f3
bpo-46079: Replace external link that is down for maintenance. (GH-30315) (GH-30329) 2022-01-01 10:13:31 -08:00
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)
8bfb11a791
bpo-46076: Improve documentation for per-attribute docstrings with __slots__ (GH-30109) (GH-30207) 2021-12-19 15:11:37 -06: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)
8202a7e3dd
[3.9] bpo-46044: Annotate deprecated sdists formats (GH-30043) (GH-30155)
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:22 -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)
309614f1f7
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:04:53 -08: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
Alex Waygood
2029c58097
[3.9] bpo-45840: Improve cross-references in the data model documentation (GH-29633) (GH-30081)
Backport of GH-29633 to the 3.9 branch
2021-12-13 14:19:08 +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)
81a38293f2
[doc] Clarify MRO precedence in descriptor super binding section (GH-29539) (GH-29670)
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:35 +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