Commit Graph

12165 Commits

Author SHA1 Message Date
Erlend E. Aasland b3e600a632
[3.11] gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls (#107062) (#107157)
(cherry picked from commit b447e19e72)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-23 23:49:48 +02:00
wulmer c51f766ebb
[3.11] gh-101100: Fix some broken sphinx references (GH-107095). (#107120) 2023-07-23 05:56:09 -06:00
Daniele Procida 6e3a2fb0fe
[3.11] gh-106996: Add the basics of a turtle graphics tutorial (GH-107072) (#107110) 2023-07-23 04:25:23 -06:00
Serhiy Storchaka ec8718dd7c
[3.11] gh-106948: Add standard external names to nitpick_ignore (GH-106949) (#107061)
It includes standard C types, macros and variables like "size_t",
"LONG_MAX" and "errno", and standard environment variables like "PATH"..
(cherry picked from commit f8b7fe2f26)
2023-07-23 11:24:37 +02:00
Miss Islington (bot) 65e40aaed0
[3.11] gh-54738: Add argparse i18n howto (GH-104562) (#107101)
(cherry picked from commit dcd7acb04a)

Co-authored-by: Tomas R <tomas.roun8@gmail.com>
2023-07-23 11:23:51 +02:00
Miss Islington (bot) 9875b177a9
[3.11] gh-107028: tiny textual changes in logging docs and docstrings (GH-107029) (GH-107066)
(cherry picked from commit 5e5a34ac3a)
2023-07-22 22:12:06 +01:00
Miss Islington (bot) 2895dbd0f6
[3.11] gh-83006: Document behavior of `shutil.disk_usage` for non-mounted filesystems on Unix (GH-107031) (#107048)
(cherry picked from commit 6e5f2235f3)

Co-authored-by: Matthieu Caneill <matthieucan@users.noreply.github.com>
2023-07-22 20:25:15 +02:00
Miss Islington (bot) e5d2a19ac5
[3.11] gh-107008: Document the curses module variables LINES and COLS (GH-107011) (GH-107058)
LINES and COLS referred in curses.update_lines_cols() documentations are
the module variables, not the environment variables.
(cherry picked from commit 26e08dfdd7)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-22 21:13:38 +03:00
wulmer b71144193b
[3.11] Fix Sphinx warnings in `re` module docs (GH-107044). (#107055)
(cherry picked from commit 149748ea4f)
2023-07-22 17:39:46 +01:00
Miss Islington (bot) c332117b52
gh-106847: Add -X warn_default_encoding in sys.flags Doc (GH-106854)
gh-106847: Add -X warn_default_encoding in sys.flags Doc (GH-106854)
(cherry picked from commit fd84ac0ee0)

Co-authored-by: qqwqqw689 <114795525+qqwqqw689@users.noreply.github.com>
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-07-23 01:23:31 +09:00
Miss Islington (bot) 755166e864
[3.11] gh-105090: Replace incorrect TLSv1.2 with TLSv1.3 (GH-105404) (#107038)
Co-authored-by: Jocelyn Castellano <admin@malwarefight.gq>
2023-07-22 14:29:54 +00:00
Sebastiaan Zeeff 4f7c23e4df
[3.11] Change non-integral to non-integer in random docs (GH-106975) (#106985) 2023-07-22 02:37:16 -06:00
Serhiy Storchaka b338ac7540
[3.11] gh-106909: Use role :const: for referencing module constants (GH-106910) (GH-106957)
(cherry picked from commit 4b9948617f)
2023-07-21 14:49:57 +03:00
Serhiy Storchaka cc76113cf8
[3.11] gh-106892: Use roles :data: and :const: for referencing module variables (GH-106894) (GH-106955)
(cherry picked from commit d036db728e)
2023-07-21 14:49:21 +03:00
Serhiy Storchaka 6bde1b9f04
[3.11] gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920) (GH-106952)
(cherry picked from commit fcc816dbff)
2023-07-21 14:48:30 +03:00
Miss Islington (bot) a5c8d240c0
[3.11] Fix typo in tkinter docs (GH-106936) (#106938)
Fix typo in tkinter docs (GH-106936)
(cherry picked from commit 60e83968d5)

Signed-off-by: Makonede <61922615+Makonede@users.noreply.github.com>
Co-authored-by: Makonede <61922615+Makonede@users.noreply.github.com>
2023-07-21 00:12:00 +01:00
Miss Islington (bot) a6313d78f2
[3.11] gh-106882: Note that `asyncio.Server` is only publicly exposed on 3.11+ (GH-106901) (#106903)
gh-106882: Note that `asyncio.Server` is only publicly exposed on 3.11+ (GH-106901)

And later versions of 3.10, 3.9
(cherry picked from commit 1e1f4e91a9)

Co-authored-by: Jack Nelson <jack@jacknelson.xyz>
2023-07-19 21:03:44 +01:00
Miss Islington (bot) 9532f0e6dd
Doc: fix section levels of devmode doc (GH-106801)
Doc: fix section levels of devmode doc (GH-106801)
(cherry picked from commit e58960160f)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2023-07-16 21:27:51 +09:00
Inada Naoki 77104f5511
Doc: devmode: add -Xdev option to example (GH-106253)
(cherry picked from commit 83bd568d2b)

Co-authored-by: Simone Rubino <daemo00@gmail.com>
2023-07-16 11:43:56 +00:00
Alex Waygood 7dead6a33a
[3.11] gh-106745: typing docs: Clarify that removal of PEP-585 aliases is not currently planned (#106748) (#106773) 2023-07-15 11:34:29 +01:00
Terry Jan Reedy 2186212191
[3.11] gh-106446: Fix failed doctest in stdtypes (GH-106447) (#106742)
(cherry picked from commit 89867d2491)

Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-07-14 04:02:25 -04:00
Miss Islington (bot) eac0616df9
[3.11] [3.12] gh-96747: Mention the PyPI `passlib` package in the `crypt` deprecation doc (GH-106660) (GH-106660) (#106697)
[3.12] gh-96747: Mention the PyPI `passlib` package in the `crypt` deprecation doc (GH-106660) (GH-106660)

* Added mention to passlib package as alternative to the deprecated crypt module.
(cherry picked from commit ec7b05a0be)

Co-authored-by: Yonatan Bitton <bityob@gmail.com>
2023-07-12 14:59:54 -07:00
Miss Islington (bot) 247f0500b8
[3.11] gh-96165: Clarify passing ":memory:" in sqlite3.connect() (GH-106451) (#106648)
cherry picked from commit f520804b03)

Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2023-07-11 22:32:08 +02:00
Miss Islington (bot) 6d8662381d
[3.11] gh-96165: Clarify omitting the FROM clause in SQLite queries (GH-106513) (#106646)
(cherry picked from commit fc7ff1af45)

Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2023-07-11 22:30:52 +02:00
Miss Islington (bot) dd04697337
[3.11] gh-106461: typing: Consolidate docs on `Callable` (GH-106462) (#106575)
gh-106461: typing: Consolidate docs on `Callable` (GH-106462)
(cherry picked from commit ca8b55c7f5)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-07-09 22:22:46 +01:00
Miss Islington (bot) 44c335e47d
[3.11] gh-101880: add link to object.__hash__() in hash() builtin documentation (GH-101883) (#106547)
gh-101880: add link to object.__hash__() in hash() builtin documentation (GH-101883)
(cherry picked from commit ec7180bd1b)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-07-08 14:23:00 +05:30
Miss Islington (bot) 80117dd450
[3.11] Doc: Add missing ref labels to exception groups/notes sections (GH-106465) (#106474)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-07-06 00:05:04 -06:00
Miss Islington (bot) ada22db147
[3.11] Clarify state of CancelledError in doc (GH-106453) (#106456)
Clarify state of CancelledError in doc (GH-106453)

This change makes it explicit that asyncio.CancelledError is not a subclass of Exception.
(cherry picked from commit 12a9813808)

Co-authored-by: Kristján Valur Jónsson <sweskman@gmail.com>
2023-07-05 11:16:56 -07:00
Miss Islington (bot) 23b731a10d
[3.11] GH-104554: Add RTSPS support to `urllib/parse.py` (GH-104605) (#105760)
RTSPS is the permanent scheme defined in
https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml
alongside RTSP and RTSPU schemes.

---------

(cherry picked from commit f3266c05b6)

Co-authored-by: zentarim <33746047+zentarim@users.noreply.github.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
2023-07-05 13:02:36 +02:00
Miss Islington (bot) f5e29f4245
[3.11] gh-101100: Docs: Fix references to several numeric dunders (GH-106278) (#106282)
gh-101100: Docs: Fix references to several numeric dunders (GH-106278)
(cherry picked from commit a8ae73965b)

Co-authored-by: F3eQnxN3RriK <drsuaimqjgar@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-30 15:40:13 +01:00
Miss Islington (bot) b952ebe4be
[3.11] gh-100408: Fix a traceback in multiprocessing example (GH-100409) (GH-106231)
(cherry picked from commit a28d4edb23)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-06-29 14:29:22 +03:00
Miss Islington (bot) ce091c96cf
[3.11] gh-101100: Fix reference to `parse_args` in `optparse.rst` (GH-105265) (#106205)
Co-authored-by: F3eQnxN3RriK <drsuaimqjgar@gmail.com>
2023-06-28 12:41:18 +00:00
Miss Islington (bot) 0523f6de1f
[3.11] gh-105993: Add possible `None` return type to `asyncio.EventLoop.start_tls` docs (GH-105995) (#106189)
gh-105993: Add possible `None` return type to `asyncio.EventLoop.start_tls` docs (GH-105995)
(cherry picked from commit 6b52a581c1)

Co-authored-by: Sam Bull <git@sambull.org>
2023-06-28 16:36:25 +05:30
Miss Islington (bot) 43c603a60f
[3.11] gh-101100: Fix reference to asynchronous methods (GH-106172) (#106192)
gh-101100: Fix reference to asynchronous methods (GH-106172)
(cherry picked from commit bbf722dcd3)

Co-authored-by: F3eQnxN3RriK <drsuaimqjgar@gmail.com>
2023-06-28 16:35:51 +05:30
Miss Islington (bot) 2cce465416
[3.11] Refer to `TimeoutError` instead of `asyncio.TimeoutError` in `asyncio-task.rst` (GH-106136) (#106180)
Co-authored-by: lightdrk <108566237+lightdrk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-06-27 23:38:26 -06:00
Miss Islington (bot) 86dbf1d112
[3.11] gh-92788: Add docs for `ast.Module`, `ast.Expression`, and others (GH-101055) (#106138)
gh-92788: Add docs for `ast.Module`, `ast.Expression`, and others (GH-101055)
(cherry picked from commit 33608fd67d)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-06-27 13:44:32 +00:00
Miss Islington (bot) 956b66b61b
[3.11] GH-105774: Clarify operation of normalize() (GH-106093) (GH-106129) 2023-06-26 23:32:43 -05:00
Miss Islington (bot) 97cf0291f5
[3.11] gh-106107: document correct error that's raised when a mutable default value for a field is detected (gh-106109) (gh-106116)
gh-106107: document correct error that's raised when a mutable default value for a field is detected (gh-106109)
(cherry picked from commit 512f299e55)

Co-authored-by: Roderich Schupp <roderich.schupp@gmail.com>
2023-06-26 14:12:40 -04:00
Miss Islington (bot) 8c792749cb
[3.11] Improve typing docs on the type of class objects (GH-106081) (#106097)
Improve typing docs on the type of class objects (GH-106081)
(cherry picked from commit 3eeb8c8906)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-26 09:43:41 +01:00
Miss Islington (bot) 1bbf60dc31
[3.11] Docs: add links to 'callable' term in sqlite3 docs (GH-106072) (#106074)
(cherry picked from commit bef1c8761e)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-06-25 10:16:30 +02:00
Miss Islington (bot) 05d06e583b
[3.11] Typing docs: fix typo in annotating tuples comment (GH-106048) (#106050)
Typing docs: fix typo in annotating tuples comment (GH-106048)
(cherry picked from commit 8ef0ee4ebc)

Co-authored-by: Eamon Tracey <66919574+EamonTracey@users.noreply.github.com>
2023-06-23 21:35:16 +01:00
Miss Islington (bot) 15f4bba7a7
[3.11] Typing docs: improve the guidance on annotating tuples (GH-106021) (#106029)
Typing docs: improve the guidance on annotating tuples (GH-106021)
(cherry picked from commit 968435ddb1)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-23 15:53:14 +01:00
Miss Islington (bot) 6d232ba2ec
[3.11] stdtypes.rst: remove a period (GH-105959) (#105969)
stdtypes.rst: remove a period (GH-105959)
(cherry picked from commit c5a722be5f)

Co-authored-by: Mathieu Dupuy <deronnax@gmail.com>
2023-06-21 15:40:46 +01:00
Alex Waygood 8bb16f6656
[3.11] typing docs: Improve the intro to each section (#105901) (#105903)
typing docs: Improve the intro to each section (#105901)
2023-06-19 01:17:06 +01:00
Carl Meyer 7c877b58e0
[3.11] bpo-44530: Document the change in MAKE_FUNCTION behavior (GH-93189) (#105842)
* bpo-44530: Document the change in MAKE_FUNCTION behavior

Fixes dis module documentation for MAKE_FUNCTION due to 2f180ce2cb (bpo-44530, released as part of 3.11) removes the qualified name at TOS.
(cherry picked from commit 486b52a315)

Co-authored-by: Alex Doe <alexdoesh@gmail.com>
2023-06-16 12:17:58 -05:00
Miss Islington (bot) aa927f9f96
[3.11] tarfile: Fix positional-only syntax in docs (GH-105770) (#105772)
The syntax used in the current docs (a / before any args) is invalid.

I think the right approach is for the arguments to arbitrary
filter functions to be treated as positional-only, meaning that users
can supply filter functions with any names for the argument. tarfile.py
only calls the filter function with positional arguments.
(cherry picked from commit 5cdd5ba49d)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-06-15 22:43:30 -07:00
Alex Waygood 6be46c37c6
[3.11] More reorganisation of the typing docs (#105787) (#105816) 2023-06-15 10:05:50 +01:00
Alex Waygood c197bd8826
[3.11] Improve docs for `typing.dataclass_transform` (#105792) (#105815)
(cherry-picked from commit 006a453205)
2023-06-15 09:56:14 +01:00
Alex Waygood ab0546881f
[3.11] Typing docs: move the deprecated stuff below the non-deprecated stuff (#105781) (#105785) 2023-06-14 15:40:02 +01:00
Alex Waygood f207b346d4
[3.11] Remove stray reference to PEP-695 in the typing docs (#105655) 2023-06-11 17:10:49 +01:00