Commit graph

23966 commits

Author SHA1 Message Date
Miss Islington (bot)
0da140da71
Update html.parser.rst (GH-30678)
This PR for the documentation of the [html.parser](https://docs.python.org/3/library/html.parser.html) module will

- fix a terminology mistake (‘start of a tag’ -> ‘start tag of an element’);
- mention the parameter names of the `HTMLParser.handle_*` methods where missing.
(cherry picked from commit 2945f5a7c5)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2022-02-17 04:46:25 -08:00
Miss Islington (bot)
1933238983
Update the OMG link (GH-30383)
(cherry picked from commit 04215a4272)

Co-authored-by: David Gilbertson <gilbertson.david@gmail.com>
2022-02-14 14:15:08 -08:00
Miss Islington (bot)
5c303f3209
doc: use colon for all color's rangs (GH-28998)
(cherry picked from commit 6b9f27dd0b)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2022-02-14 12:13:33 -08:00
Miss Islington (bot)
1953f03174
bpo-38619: Update the documentation for UUID.hex (GH-29830)
Explicitly state that it is lowercase.

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
(cherry picked from commit 5d53cf30f9)

Co-authored-by: 180909 <wjh180909@gmail.com>
2022-02-14 11:25:15 -08:00
Miss Islington (bot)
0bd2d58f36
Fix minor grammar error (GH-31325)
"an" followed by consonant should be "a"
(cherry picked from commit 0d29e7a06f)

Co-authored-by: Scott Noyes <snoyes@gmail.com>
2022-02-14 11:10:38 -08:00
John Belmonte
0b1417d597
[3.9] Corrections to format precision description. (GH-31291) (GH-31321)
* `precision` field is a decimal integer
  * clarify that stated limitations are on presentation type
    rather than input value type.  Especially misleading is
    "precision is not allowed for integer values", since integer
    value input to a format like `.1f` is fine.
  * regarding max field size, replace "non-number" with "string",
    which is the only non-numeric presentation type

Automerge-Triggered-By: GH:ericvsmith.
(cherry picked from commit 1d6ce67c29)

Co-authored-by: John Belmonte <john@neggie.net>
2022-02-13 22:05:11 -05:00
Miss Islington (bot)
ebe73e6095
bpo-45447: Add entry to What's new 3.9 (GH-31305)
(cherry picked from commit cef91ca80c)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-02-12 22:30:36 -08:00
Miss Islington (bot)
a7c1cc4169
bpo-46483: [doc] pathlib classes no longer support parameterized generics (GH-31281)
Remove pathlib classes from the list in stdtypes.rst of classes
that can be parameterized at runtime.
(cherry picked from commit e0bc8ee945)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-02-11 13:03:45 -08:00
Miss Islington (bot)
c23f4ab3f5
Fix the signature of multiprocessing.set_executable (GH-31276)
Automerge-Triggered-By: GH:merwok
(cherry picked from commit 4f9386661d)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2022-02-11 07:08:44 -08:00
Miss Islington (bot)
459e26f098
[3.9] bpo-46609: Update asyncio-task coroutine doc (GH-31132)
@coroutine in removed in 3.11, not 3.10.
(cherry picked from commit 5603db43ba)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-02-04 15:46:09 -05:00
Miss Islington (bot)
ee3d050e85
Optimize images by IMGbot (GH-21348)
Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>
(cherry picked from commit ba650af7d6)

Co-authored-by: Manish Kumar  <manishprivet@protonmail.com>
2022-02-03 23:15:17 -08:00
Miss Islington (bot)
1440dd3438
bpo-23556: [doc] Fix inaccuracy in documentation for raise without args. Improve tests for context in nested except handlers. (GH-29236)
(cherry picked from commit 08c0ed2d9c)

Co-authored-by: Kinshuk Dua <kinshukdua@gmail.com>
2022-01-27 02:50:43 -08:00
Miss Islington (bot)
bc7d96ee33
bpo-45296: Clarify close, quit, and exit in IDLE (GH-30936)
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>
2022-01-26 19:41:13 -08:00
Pablo Galindo Salgado
dafada393f
[3.9] bpo-46502: Remove "How do I tell incomplete input" from FAQ (GH-30925) (GH-30934)
Since,

- Py_CompileString no longer allows to distinguish "incomplete input"
  from "invalid input"
- there is no alternative solution available from the Python C API
  due to how the new parser works (rewritten in 3.9)
- the only supported way is to manually import the codeop module from C
  and use its API as IDLE does, and accept its own complications

it is desirable to remove this Q&A from the official FAQ..
(cherry picked from commit f0a648152f)

Co-authored-by: Mateusz Łoskot <mateusz@loskot.net>

Co-authored-by: Mateusz Łoskot <mateusz@loskot.net>
2022-01-27 00:16:44 +00:00
Miss Islington (bot)
49971b2d18
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:39 -08:00
Miss Islington (bot)
f8a805bde1
bpo-41844: Update IDLE part of What's New 3.9 to 20228 (GH-30905)
(cherry picked from commit 7cf285d82e)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-01-25 21:15:03 -08:00
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