Commit graph

24617 commits

Author SHA1 Message Date
Miss Islington (bot)
625f6704c0
bpo-14911: Corrected generator.throw() documentation (GH-32207)
Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
(cherry picked from commit 8be7c2bc5a)

Co-authored-by: Dave Goncalves <davegoncalves@gmail.com>
2022-03-31 07:23:04 -07:00
Miss Islington (bot)
66cde7c51a
bpo-42340: Document issues around KeyboardInterrupt (GH-23255)
Update documentation to note that in some circumstances,
KeyboardInterrupt may cause code to enter an inconsistent state. Also
document sample workaround to avoid KeyboardInterrupt, if needed.
(cherry picked from commit d0906c90fc)

Co-authored-by: benfogle <benfogle@gmail.com>
2022-03-29 14:45:47 -07:00
Miss Islington (bot)
11408ff47e
ctypes docs: Fix array-length reference to "non-negative" from "positive" (GH-32097) (GH-32142)
(cherry picked from commit 76f14b0463)

Co-authored-by: Yonatan Goldschmidt <yon.goldschmidt@gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-03-28 19:47:57 -07:00
Jelle Zijlstra
604d003ab4
[3.10] bpo-28516: document contextlib.ExitStack.__enter__ behavior (GH-31636) (GH-32171)
The enter_context is updated with following information: 'The :meth:`__enter__` method
      returns the ExitStack instance, and performs no additional operations.'

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 86384cf83f)

Co-authored-by: vidhya <96202776+Vidhyavinu@users.noreply.github.com>
2022-03-28 19:39:55 -07:00
Steve Dower
0dfabf9b4a
bpo-47138: Ensure Windows docs build uses the same pinned version as other platforms (GH-32161) 2022-03-29 00:46:18 +01:00
Hugo van Kemenade
9194a7b899
bpo-47138: Fix documentation build by pinning Jinja version to 3.0.3 (GH-32154)
Co-authored-by: Maciej Olko <maciej.olko@gmail.com>
2022-03-28 13:06:16 -04:00
Miss Islington (bot)
48b3ae9e29
bpo-47105: Cite grp.h instead of pwd.h in grp docs (GH-32091) (GH-32120)
(cherry picked from commit ee912ad6f6)

Co-authored-by: Alex Hedges <aphedges@users.noreply.github.com>
2022-03-25 20:21:50 -04:00
Miss Islington (bot)
4298114e1d
Correctly document class instead of function (GH-32016)
(cherry picked from commit 624e3986fb)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-03-23 09:17:53 -07:00
Miss Islington (bot)
832be8f1d4
[doc] configparser: avoid inline comments. (GH-31247)
People are testing those blocs with the default
inline_comment_prefixes of None, leading to a:

configparser.InterpolationSyntaxError: '$' must be followed by '$' or '{', found: '$ sign ($ is the only character that needs to be escaped)'
(cherry picked from commit 3ac4e783e0)

Co-authored-by: Julien Palard <julien@palard.fr>
2022-03-23 01:58:49 -07:00
Miss Islington (bot)
ca6acb8b31
Fix typo in Path.iterdir docs (GH-31822)
(cherry picked from commit 795b365e8a)

Co-authored-by: Matt Williams <matt@milliams.com>
2022-03-22 20:14:30 -07:00
Alex Waygood
d5ed8a8258
[3.10] bpo-46769: Improve documentation for typing.TypeVar (GH-31712) (GH-31941)
* [3.10] bpo-46769: Improve documentation for `typing.TypeVar` (GH-31712)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 81b425d4dc)

* Remove references to `reveal_type`, add new section on `self` types
2022-03-22 19:52:40 -07:00
Miss Islington (bot)
c3538355f4
[3.10] bpo-47061: document module deprecations due to PEP 594 (GH-31984) (GH-32039)
Also removed asynchat, asyncore, and smtpd from their respective toctree entries so they are only  in the superceded subtree.
(cherry picked from commit 9ac2de922a)


Co-authored-by: Brett Cannon <brett@python.org>

Automerge-Triggered-By: GH:brettcannon
2022-03-21 17:30:21 -07:00
Irit Katriel
7fc12540e3
bpo-12029: [doc] clarify that except does not match virtual subclasses of the specified exception type (GH-32027) (GH-32034)
(cherry picked from commit 45833b50f0)
2022-03-21 21:22:39 +00:00
Hugo van Kemenade
94f038cbb2
[3.10] bpo-47022: Document asynchat, asyncore and smtpd removals in 3.12 (GH-31891) (#31997)
Document the deprecation of asyncore, asynchat, and smtpd with a slated removal in Python 3.12 thanks to PEP 594..
(cherry picked from commit 7747384643)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-03-20 22:38:01 +02:00
Miss Islington (bot)
87b3e202d4
bpo-46013: Fix confusing kerning on period in docs (GH-29989) (GH-32005)
(cherry picked from commit 3af68fc77c)

Co-authored-by: jmcb <joel.mcbride1@live.com>

Co-authored-by: jmcb <joel.mcbride1@live.com>
2022-03-20 12:17:19 +00:00
Ma Lin
6d290d5862
[3.10] bpo-47040: improve document of checksum functions (GH-31955) (GH-32002)
Clarifies a versionchanged note on crc32 & adler32 docs that the workaround is only needed for Python 2 and earlier.
Also cleans up an unnecessary intermediate variable in the implementation.

Authored-By: Ma Lin / animalize
Co-authored-by: Gregory P. Smith <greg@krypto.org>
2022-03-19 23:57:12 -07:00
Miss Islington (bot)
c1f327f30d
bpo-44544: add textwrap placeholder arg (GH-27671)
(cherry picked from commit cb7874f49d)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2022-03-19 05:47:58 -07:00
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