Commit graph

24540 commits

Author SHA1 Message Date
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)
d548c87171
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:11:47 -08:00
Miss Islington (bot)
68a31dba97
no-issue: Fix documentation typos. (GH-30576)
(cherry picked from commit d05a66339b)

Co-authored-by: Piotr Fusik <piotr@fusik.info>
2022-01-21 04:45:42 -08: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
Miss Islington (bot)
0861a50bd4
bpo-22039: [doc] clarify that there are no plans to disable deleting an attribute via PyObject_SetAttr (GH-30639) (GH-30684)
(cherry picked from commit 3bf6315c4c)

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

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-01-19 12:34:17 +00: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)
6f035c07e0
[doc] Add license_url for python-docs-theme 2022.1. (GH-30527) (GH-30540)
(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:33 +01:00
Miss Islington (bot)
4cfb10979d
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:53:08 -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)
2e6798f352
bpo-46270: Describe the in and not in operators as membership tests. (GH-30504) (GH-30509) 2022-01-09 18:31:51 -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)
75a1865d1c
[3.10] bpo-24650: Use full term "generator function" in yield expressions docs (GH-24663) (GH-30461)
(cherry picked from commit 273cb8e757)


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

Automerge-Triggered-By: GH:iritkatriel
2022-01-07 11:01:33 -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)
743394f281
bpo-46231: Remove invalid_* rules preceded by more tokens from the grammar docs (GH-30341)
(cherry picked from commit e09d94a140)

Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
2022-01-04 03:03:46 -08: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)
0b3c3cbbaf
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:10:20 -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)
35955e4ade
[3.10] Update copyright year to 2022. (GH-30335) (GH-30336)
Automerge-Triggered-By: GH:benjaminp
(cherry picked from commit ba00f0d93a)


Co-authored-by: Benjamin Peterson <benjamin@python.org>
2022-01-02 13:13:04 -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)
2bd7354695
bpo-46079: Replace external link that is down for maintenance. (GH-30315) (GH-30328) 2022-01-01 10:12:59 -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)
d968e422ef
docs: Fix typos and use anchor for internal link (GH-30236)
(cherry picked from commit c1d7a6bed9)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2021-12-26 03:29:58 -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)
d7537ac8e3
bpo-46076: Improve documentation for per-attribute docstrings with __slots__ (GH-30109) (GH-30206) 2021-12-19 15:11:12 -06:00
Miss Islington (bot)
9a28cf19b5
bpo-46130: [docs] Add anchor for whatsnew/3.10 type hint section (GH-30199)
This allows the title to be translated to other languages without linking problems.
(cherry picked from commit 3d3615f41f)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2021-12-19 06:32:49 -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)
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