Commit graph

24600 commits

Author SHA1 Message Date
Miss Islington (bot)
9f1587e8d3
bpo-31415: importtime was made by Inada Naoki (GH-31875)
(cherry picked from commit 29624e769c)

Co-authored-by: Victor Stinner <vstinner@python.org>
2022-03-14 14:24:50 -07:00
Miss Islington (bot)
efa7250159
[3.10] bpo-30677: [doc] mention that os.mkdir() can raise FileNotFoundError (GH-31548) (GH-31877)
(cherry picked from commit 879fbd9472)


Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>

Automerge-Triggered-By: GH:iritkatriel
2022-03-14 13:50:41 -07:00
Illia Volochii
c682840834
[3.10] bpo-43215: Document Happy Eyeballs args of asyncio.open_connection (GH-24525) (GH-31869)
Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
(cherry picked from commit 3543ddb4c4)

Co-authored-by: Illia Volochii <illia.volochii@gmail.com>
2022-03-14 15:16:29 +02:00
Jason R. Coombs
d929aa70e2
[3.10] bpo-47004: Sync with importlib_metadata 4.11.3. (GH-31854). (GH-31857)
(cherry picked from commit b1e2868607)

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
2022-03-13 17:29:50 -04:00
Jelle Zijlstra
d8ba5c102c
[3.10] sqlite3: normalise pre-acronym determiners (GH-31772) (GH-31806)
For consistency, replace "a SQL" with "an SQL"..
(cherry picked from commit 2d5835a019)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2022-03-11 17:10:55 -08:00
Charlie Zhao
28f20a6613
[3.10] bpo-46677: Add examples of inheritance and attributes to TypedDict docs (GH-31349) (GH-31815)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 8a207e0321)

Co-authored-by: Charlie Zhao <68189100+CharlieZhao95@users.noreply.github.com>
2022-03-11 17:03:52 -08:00
Miss Islington (bot)
b35b36e106
bpo-31327: Update time documentation to reflect possible errors (GH-31460)
As per the comments, this mirrors the [datetime documentation](https://docs.python.org/3/library/datetime.htmlGH-datetime.datetime.fromtimestamp).

```
>>> import time
>>> time.localtime(999999999999999999999)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
OverflowError: timestamp out of range for platform time_t
>>> time.localtime(-3600)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
OSError: [Errno 22] Invalid argument
```
(cherry picked from commit c83fc9c02c)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-03-11 11:29:48 -08:00
Miss Islington (bot)
3386f87dcb
Remove print race from task_done example. (GH-31795)
(cherry picked from commit a0eb69c1a2)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2022-03-10 09:22:46 -08:00
Jelle Zijlstra
5dfe981791
[3.10] Docstring: replace pysqlite with sqlite3 (GH-31758) (GH-31777)
Replace two instances of "pysqlite" with "sqlite3" in sqlite3
docstrings. Also reword "is a no-op" to "does nothing" for clarity..
(cherry picked from commit b33a1ae703)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2022-03-09 10:19:27 -08:00
Miss Islington (bot)
ef54c4df82
Removed confusing reference to sys (GH-31638)
(cherry picked from commit 28f84c72b6)

Co-authored-by: David Gilbertson <gilbertson.david@gmail.com>
2022-03-08 08:04:56 -08:00
Jelle Zijlstra
5d2b9c9fe4
[3.10] docs: Don't use code formatting for emphasis (GH-30519) (GH-31764)
(cherry picked from commit badb637c8c)

Co-authored-by: William Andrea <william.j.andrea@gmail.com>
2022-03-08 07:42:54 -08:00
Miss Islington (bot)
b099363fa7
Removed ambiguity in __init_subclass__ docs (GH-31540)
(cherry picked from commit ab014978ae)

Co-authored-by: David Gilbertson <gilbertson.david@gmail.com>
2022-03-07 20:33:19 -08:00
Miss Islington (bot)
e053f0e9f4
bpo-46494: Mention the typing_extensions pkg in typing docs (GH-31260)
(cherry picked from commit 8debeed307)

Co-authored-by: Meer Suri <46469858+meersuri@users.noreply.github.com>
2022-03-07 20:25:30 -08:00
Miss Islington (bot)
f6cdf5bdcc
importlib.metadata: Remove empty footnote section (GH-30451)
(cherry picked from commit 13331a12c3)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2022-03-07 20:21:32 -08:00
Miss Islington (bot)
06108c08dd
bpo-45680: Improve docs on subscriptions w.r.t. GenericAlias objects (GH-29479)
(cherry picked from commit 50731297a9)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-03-07 20:12:59 -08:00
Miss Islington (bot)
fa69ec8939
bpo-38738: Fix formatting of True and False in the threading documentation (GH-31678)
* Fix formatting of True and False in the threading documentation
* Update threading.rst
(cherry picked from commit 46a116c1c9)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2022-03-04 12:37:56 -08:00
Miss Islington (bot)
bdce188036
bpo-25415: Remove confusing sentence from IOBase docstrings (PR-31631)
(cherry picked from commit cedd2473a9)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-03-04 10:33:57 -08:00
Miss Islington (bot)
9d9dc59d07
bpo-6634: [doc] clarify that sys.exit() does not always exit the interpreter (GH-31639)
(cherry picked from commit 10117f1d8c)

Co-authored-by: vidhya <96202776+Vidhyavinu@users.noreply.github.com>
2022-03-03 06:49:22 -08:00
Miss Islington (bot)
60b561c246
bpo-21910: Clarify docs for codecs writelines method (GH-31245)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit a8c87a239e)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-03-02 17:43:00 -08:00
Irit Katriel
eb65e46b9b
[3.10] bpo-45492: Corrected documentation for co_names in inspect library doc (GH-31456). (GH-31645)
(cherry picked from commit 3257d49d23)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-03-02 19:37:17 +00:00
Miss Islington (bot)
7dbb2f8eaf
bpo-42982: update pbkdf2 example & add another link (GH-30966) (#30968)
Automerge-Triggered-By: GH:gpshead
(cherry picked from commit ace0aa2a27)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2022-03-01 15:56:25 -05:00
Miss Islington (bot)
98e2ee60bd
Add missing "to" to two tp_flags notes (GH-31624)
(cherry picked from commit 422fdb3717)

Co-authored-by: Brandt Bucher <brandtbucher@microsoft.com>
2022-02-28 17:45:26 -08:00
Miss Islington (bot)
1f956d11db
bpo-26897: Clarify Popen stdin, stdout, stderr file object docs (GH-30231)
(cherry picked from commit dd69f73421)

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-02-25 09:03:37 -08:00
Miss Islington (bot)
8b37a0c522
Update dict/OrderedDict differences with code equivalents. (GH-31563)
(cherry picked from commit 26aba295a9)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2022-02-25 07:15:58 -08:00
Miss Islington (bot)
632a8121d4
bpo-34429: Noted TemporaryFile behavior on non-Posix/non-Cygwin systems (GH-31547)
(cherry picked from commit 53ecf9e08d)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-02-25 03:30:31 -08:00
Miss Islington (bot)
b0de6299a8
bpo-40421: Fix PyFrame_GetCode() documentation (GH-31535)
Fix PyFrame_GetBack() and PyFrame_GetCode() return type in
the documentation.
(cherry picked from commit 78859e58e4)

Co-authored-by: Victor Stinner <vstinner@python.org>
2022-02-23 11:12:51 -08:00
Miss Islington (bot)
28d9353305
Minor fixes to C API docs (GH-31501)
* C API docs: move PyErr_SetImportErrorSubclass docs

It was in the section about warnings, but it makes more sense to
put it with PyErr_SetImportError.

* C API docs: document closeit argument to PyRun_AnyFileExFlags

It was already documented for PyRun_SimpleFileExFlags.

* textual fixes to unicode docs

* Move paragraph about tp_dealloc into tp_dealloc section

* __aiter__ returns an async iterator, not an awaitable
(cherry picked from commit 43cf44ddcc)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-02-22 20:57:02 -08:00
Miss Islington (bot)
a7af34d407
[3.10] bpo-20923 : [doc] Explain ConfigParser 'valid section name' and .SECTCRE (GH-31413) (GH-31506)
(cherry picked from commit bba8008f99)


Co-authored-by: vidhya <96202776+Vidhyavinu@users.noreply.github.com>

Automerge-Triggered-By: GH:iritkatriel
2022-02-22 10:28:34 -08:00
Miss Islington (bot)
d04fb9213a
[3.10] bpo-36557: Updated wording for using/windows (GH-31457) (GH-31504)
(cherry picked from commit 9a0d941df4)


Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>

Automerge-Triggered-By: GH:iritkatriel
2022-02-22 09:57:01 -08:00
Miss Islington (bot)
a2e13ec0ce
[docs] Correct typos in SSLContext.sni_callback (GH-30623) (GH-31421)
Co-authored-by: Jörn Heissler <nosuchaddress@joern-heissler.de>
(cherry picked from commit f80a97b492)

Co-authored-by: Jörn Heissler <joernheissler@users.noreply.github.com>
2022-02-20 16:17:56 -08:00
Miss Islington (bot)
ea3e0421b0
Improve discussion about how __getattr__ is invoked. (GH-31435) (GH-31437) 2022-02-19 23:25:57 -06:00
Miss Islington (bot)
75c5dbc27e
Counter doc mentions three methods, but lists four (GH-30706)
Was probably caused by the addition of the `total()` method
(cherry picked from commit 99331fcf17)

Co-authored-by: Charles Brunet <charles.brunet@optelgroup.com>
2022-02-18 18:45:56 -08:00
Miss Islington (bot)
6eb34772fd
bpo-46777: Fix incorrect use of directives in asyncio documentation (GH-31388)
(cherry picked from commit 2923d87ca2)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-02-18 01:30:36 -08:00
Miss Islington (bot)
feb4455088
docs: Link match statement in tutorial (GH-31396)
Add a link to the `match` statement from its section in the tutorial.

Automerge-Triggered-By: GH:Mariatta
(cherry picked from commit 35f55cc5c6)

Co-authored-by: William Andrea <william.j.andrea@gmail.com>
2022-02-17 23:15:00 -05:00
Miss Islington (bot)
68e80c4e74
[3.10] Update html.parser.rst (GH-30678) (GH-31385)
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>

Automerge-Triggered-By: GH:merwok
2022-02-17 04:41:07 -08:00
Miss Islington (bot)
5b63ba3ff5
Update the OMG link (GH-30383)
(cherry picked from commit 04215a4272)

Co-authored-by: David Gilbertson <gilbertson.david@gmail.com>

Co-authored-by: David Gilbertson <gilbertson.david@gmail.com>
2022-02-15 09:17:00 -08:00
Miss Islington (bot)
543242ad8c
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>

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2022-02-14 12:11:02 -08:00
Miss Islington (bot)
a414cb35c2
Update __main__.rst (GH-30896)
The reference to `venv` appears in the paragraph below, instead of above.
Fixed the documentation.
(cherry picked from commit 4e4e7c2684)

Co-authored-by: David Gilbertson <gilbertson.david@gmail.com>

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

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2022-02-14 12:10:05 -08:00
Miss Islington (bot)
828253227e
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:20:48 -08:00
Miss Islington (bot)
5574cacf57
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:09:57 -08:00
Miss Islington (bot)
a606c6a350
Fix a typo in Doc/faq/programming.rst (GH-31243)
is not longer used -> is no longer used
(cherry picked from commit ff5a167597)

Co-authored-by: Cooper Lees <me@cooperlees.com>
2022-02-14 11:08:39 -08:00
Dennis Sweeney
841c77d802
[3.10] bpo-46747: Add missing key parameters in the bisect docs (GH-31323) (GH-31329)
Added *key* parameter to `bisect.bisect()` and `bisect.insort()` in bisect module docs.
(cherry picked from commit 96084f4256)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2022-02-14 11:51:16 -05:00
Miss Islington (bot)
6a7dd3f9e9
Corrections to format precision description. (GH-31291)
* `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 16:21:32 -08:00
Miss Islington (bot)
44666c3285
bpo-45447: Add entry to What's new 3.10 (GH-31304)
(cherry picked from commit 2d98433549)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-02-12 22:31:03 -08:00
Miss Islington (bot)
5698e0be8e
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:25 -08:00
Miss Islington (bot)
f2fbfbe0ec
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:04:01 -08:00
Miss Islington (bot)
7445949a43
bpo-43532: add version added to KW_ONLY (GH-31235)
Minor missing version note mentioned at the end of  (and affected me independently before reading that note).

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

Co-authored-by: Henry Schreiner <HenrySchreinerIII@gmail.com>
2022-02-09 13:18:52 -08:00
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