3ddf397217
gh-101100: Documenting --prefix and --exec-prefix. (GH-102695)
...
(cherry picked from commit 61b9ff35cb
2023-03-15 15:13:48 -07:00
6b6c2f53ec
[3.11] Remove misformatted exclamation marks in docs (GH-102694) ( #102716 )
...
Remove the exclamation mark from :program:`!foo` in .rst files because
it inadvertently shows up in the rendered HTML.
(Sphinx's cross-referencing roles use a '!' prefix to suppress
hyperlinking[1], but :program: is not a cross-referencing role so the
'!' is displayed verbatim.)
The exclamation marks in venv.rst were introduced in #98350 . See
comments [2] and [3] for additional discussion.
[1]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#cross-referencing-syntax
[2]: https://github.com/python/cpython/pull/98350#issuecomment-1285965759
[3]: https://github.com/python/cpython/pull/98350#issuecomment-1286394047
Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Co-authored-by: Tom Levy <tomlevy93@gmail.com>
2023-03-15 09:25:55 +02:00
738dde303b
[3.11] gh-102354: change python3 to python in docs examples (GH-102696) ( #102697 )
...
gh-102354: change python3 to python in docs examples (GH-102696)
(cherry picked from commit 80abd62647
2023-03-14 12:52:33 -06:00
0f46d42eb9
doc: Remove a duplicate 'versionchanged' in library/asyncio-task (gh-102677)
...
(cherry picked from commit 7bdb331b67
2023-03-13 19:26:11 -07:00
43f8082b1c
gh-102627: Replace address pointing toward malicious web page (GH-102630)
...
* Replace known bad address pointing toward a malicious web page.
(cherry picked from commit 61479d4684
2023-03-13 15:43:16 -07:00
a4fcd06c50
[3.11] Fix duplicated words in the docs ( #102644 )
...
(cherry-picked from commit f6ca71a422
2023-03-13 14:31:50 +00:00
c39a1d0ba9
gh-101100: Fix Sphinx warnings in `turtle` module (GH-102340)
...
(cherry picked from commit 78e4e6c3d7
2023-03-13 04:33:38 -07:00
6829b1256a
[3.11] Fixes duplicated word (GH-102623) ( #102624 )
...
Fixes duplicated word (GH-102623)
In line 1627, the end of the sentence reads "only that that it may be." but it should read "only that it may be" (or alternatively "only that that may be").
(cherry picked from commit e6210621be
2023-03-12 10:00:04 -07:00
495cd2de77
gh-86509: Add link to Lib/_threading_local.py in threading docs (GH-101824)
...
(cherry picked from commit 53dceb53ad
2023-03-10 04:30:24 -08:00
ffb41eaaf4
gh-101100: Fix sphinx warnings in `zipapp` and `zipfile` modules (GH-102526)
...
(cherry picked from commit 1f557f94c2
2023-03-08 00:30:44 -08:00
8bf8e3d9a0
Fix style in argparse.rst (GH-101733)
...
(cherry picked from commit 061325e0d2
2023-03-07 23:33:52 -08:00
caff048cb3
[3.11] Move around example in to_bytes() to avoid confusion (GH-101595) ( #102434 )
...
Move around example in to_bytes() to avoid confusion (GH-101595)
Moves an example to be closer to the sentence that refers to it.
(cherry picked from commit 5da379ca7d
2023-03-05 09:42:36 +00:00
cda1d52ab8
[3.11] Clarify re docs for byte pattern group names (GH-99308) ( #101001 )
...
Fix wording of the deprecation notice in re for 3.11
2023-03-04 13:36:42 -08:00
32a738e5b3
gh-101754: Document that Windows converts keys in `os.environ` to uppercase (GH-101840)
...
(cherry picked from commit 4e7c0cbf59
2023-03-03 03:00:06 -08:00
3b1201daf6
[3.11] Fix typos in documentation and comments (GH-102374) ( #102376 )
...
[3.11] Fix typos in documentation and comments (GH-102374)
Found some duplicate `to`s in the documentation and some code comments and fixed them.
[Misc/NEWS.d/3.12.0a1.rst](ed55c69ebd/Misc/NEWS.d/3.12.0a1.rst
2023-03-02 16:00:06 +00:00
9a5f2e8562
[3.11] gh-90744: Fix erroneous doc links in the sys module (GH-101319) ( #102321 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Brad Wolfe <brad.wolfe@gmail.com>
Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
Fix erroneous doc links in the sys module (#101319 )
2023-03-02 07:43:44 +02:00
3effccee48
[3.11] gh-102088 Optimize iter_index itertools recipe (GH-102360) (GH-102363)
2023-03-01 21:52:37 -06:00
1ef6e45f96
gh-102296 Document that inspect.Parameter kinds support ordering (GH-102297)
...
(cherry picked from commit 0db6f44259
2023-02-27 07:21:27 -08:00
bd4a709038
gh-101100: Fix sphinx warnings in `types` module (GH-102274)
...
(cherry picked from commit 101a12c576
2023-02-26 23:33:05 -08:00
626f471d88
[3.11] gh-85417: Clarify behaviour on branch cuts in cmath module (GH-102046) ( #102276 )
...
gh-85417: Clarify behaviour on branch cuts in cmath module (GH-102046)
This PR updates the cmath module documentation to reflect the reality that Python is almost always (and as far as I can tell, that "almost" can be omitted) running on a machine whose C double supports signed zeros.
* Removes misleading references to functions being continuous from above / below / the left / the right at branch cuts
* Expands the note on branch cuts at the top of the module documentation to explain the double-sided sign-of-zero-based behaviour
(cherry picked from commit b513c46d99
2023-02-26 11:55:25 +00:00
7a0dc8a802
gh-102259: Fix re doc issue regarding right square brackets (GH-102264)
...
(cherry picked from commit bcadcde712
2023-02-25 18:32:42 -08:00
735ff5ae27
[3.11] GH-99818: improve the documentation for zipfile.Path and Traversable (GH-101589) ( #102266 )
...
Automerge-Triggered-By: GH:FFY00
(cherry picked from commit 84181c1404
2023-02-25 23:42:30 +00:00
c2f42f1778
gh-101100: Fix sphinx warnings in `typing` module docs (GH-102260)
...
(cherry picked from commit a498de4c0e
2023-02-25 13:55:49 -08:00
5775863e9d
asyncio docs: Fix dangling hyphen (GH-102227)
...
Currently this gets rendered with a dangling hyphen.
(cherry picked from commit 207e1c5cae
2023-02-25 05:29:35 -08:00
a109ce00de
gh-101100: Fix Sphinx warnings in `decimal` module (GH-102125)
...
(cherry picked from commit b7c1126447
2023-02-25 01:58:52 -08:00
3b4f8fc83d
gh-102105 Fix wording in filterfalse/quantify/filter (GH-102189)
...
(cherry picked from commit 81bf10e4f2
2023-02-24 08:21:40 -08:00
42d0ca92ed
[3.11] gh-100226: Clarify StreamReader.read behavior (GH-101807) ( #102001 )
...
gh-100226: Clarify StreamReader.read behavior (GH-101807)
(cherry picked from commit 77d95c8373
2023-02-23 19:05:59 +05:30
bf0a8362cd
Fix syntax error in struct doc example (GH-102160)
...
Missing closing ) reported on Discuss by Chukwudi Nwachukwu.
(cherry picked from commit 8f647477f0
2023-02-22 16:02:31 -08:00
8b5498e367
GH-101777: `queue.rst`: use 2 spaces after a period to be consistent. (GH-102143)
...
(cherry picked from commit 96bf24380e
2023-02-22 13:39:05 -08:00
528e91c067
[3.11] gh-102135: Update turtle docs to rename wikipedia demo to rosette (GH-102137) (GH-102138)
...
(cherry picked from commit 8d46c7ed5e
2023-02-22 02:25:17 -08:00
78eee76185
gh-102011: use sys.exception() instead of sys.exc_info() in docs where possible (GH-102012)
...
(cherry picked from commit 4d3bc89a3f
2023-02-21 03:06:20 -08:00
a94f3ad10b
gh-100556: Improve clarity of `or` docs (GH-100589)
...
(cherry picked from commit b40dd71241
2023-02-21 02:45:49 -08:00
f94ffcf618
gh-101777: Make `PriorityQueue` docs slightly clearer (GH-102026)
...
Adjust wording slightly, and use min(entries) instead of
sorted(list(entries))[0] as an example.
(cherry picked from commit 350ba7c07f
2023-02-21 02:32:58 -08:00
4969903f7e
gh-99735: Use required=True in argparse subparsers example (GH-100927)
...
(cherry picked from commit 6aab56f3c2
2023-02-19 11:11:40 -08:00
62db23c944
Fix incorrectly documented attribute in csv docs (GH-101250)
...
(cherry picked from commit 36b670908b
2023-02-18 17:04:01 -08:00
5220c2df9e
[3.11] gh-85747: Active voice & suggested edits, 'running/stopping loop' & 'callbacks' subsections of asyncio-eventloop.rst (GH-100270) ( #102006 )
...
Note: the `timeout` parameter was not added until 3.12.
(cherry picked from commit c4de6b1d52
2023-02-18 15:57:06 -08:00
b7a49eb5ff
gh-101739: [Enum] update docs - default boundary for Flag is CONFORM (GH-101746)
...
(cherry picked from commit 7f1c721756
2023-02-17 13:44:45 -08:00
be69ac3c96
gh-101992: update plistlib examples to be runnable (GH-101994)
...
* gh-101992: update plistlib examples to be runnable
* Update Doc/library/plistlib.rst
---------
(cherry picked from commit a1723caabf
2023-02-17 11:39:14 -08:00
aedf38391a
gh-93573: Replace wrong example domains in configparser doc (GH-93574)
...
* Replace bitbucket.org domain by forge.example
* Update example to python.org
* Use explicitly invalid domain
topsecret.server.com domain is not controled by PSF. It's replaced by invalid topsecret.server.example domain. It follows RFC 2606, which advise .example as TLD for documentation.
(cherry picked from commit 924a3bfa28
2023-02-16 07:25:31 -08:00
4aeae28671
GH-101898: Fix missing term references for hashable definition (GH-101899)
...
Fix missing term references for hashable definition
(cherry picked from commit 3690688149
2023-02-14 02:45:42 -08:00
01b21c320b
Correct trivial grammar in reset_mock docs (GH-101861)
...
(cherry picked from commit a1f08f5f19
2023-02-13 01:20:18 -08:00
91fb7c36a3
[3.11] gh-101390: Fix docs for `imporlib.util.LazyLoader.factory` to properly call it a class method (GH-101391) (#GH-101813)
...
gh-101390: Fix docs for `imporlib.util.LazyLoader.factory` to properly call it a class method (GH-101391)
(cherry picked from commit 17143e2c30
2023-02-10 16:24:28 -08:00
c485f0e39e
[3.11] Docs: Fix getstatus() -> getcode() typos (GH-101296) ( #101805 )
2023-02-11 00:26:41 +02:00
18313ecb09
Docs: use parameter list for sqlite3.Cursor.execute* (GH-101782)
...
(cherry picked from commit 2037ebf81b
2023-02-10 10:01:38 -08:00
4a9dff0e5a
gh-101283: Version was just released, so should be changed in 3.11.3 (GH-101719)
...
(cherry picked from commit 0e0c5d8baa
2023-02-08 16:11:36 -08:00
51b079a2d6
Update Lib/subprocess.py
2023-02-08 15:44:06 -08:00
7240ba7f94
[3.11] gh-47937: Note that Popen attributes are read-only (GH-93070) ( #101684 )
...
* Note that Popen attributes aren't meant to be set by users by rewording the text about the attributes.
* Also update some universal_newlines references to mention the modern text parameter name while in the area.
(cherry picked from commit 027adf42cd
2023-02-08 11:03:56 +01:00
fa90671480
[3.11] gh-97725: Fix documentation for the default file of `asyncio.Task.print_stack` ( #101652 ) ( #101653 )
...
(cherry picked from commit f87f6e2396
2023-02-08 11:02:37 +01:00
7cbcfbe2ff
GH-56426: Add cross-reference to the documentation for faulthandler, traceback, and pdb. (GH-101157)
...
(cherry picked from commit cef9de62b8
2023-02-03 19:56:57 -08:00
2366c1a4fe
gh-100920: Update documentation for `asyncio.StreamWriter.wait_closed` (GH-101514)
...
(cherry picked from commit 5c39daf50b
2023-02-02 23:26:37 -08:00
bfac5d9850
gh-100925: Move array methods under class in array doc (GH-101485)
...
* Move array methods under class in array doc
* Fix a few internal references related to the touched lines
(cherry picked from commit 1b6045668d
2023-02-02 16:12:09 -08:00
08f5c77359
docs: Fix enum reassign `str` documentation (GH-101507)
...
(cherry picked from commit 24cbc7a2a0
2023-02-02 12:40:30 -08:00
c2c970fc26
Docs: improve accuracy of sqlite3 `check_same_thread` parameter (GH-101351)
...
(cherry picked from commit ee21110086
2023-02-01 16:00:27 -08:00
89442e18e1
gh-101498 : Fix asyncio.Timeout example in docs (GH-101499)
...
Doc/library/asyncio-task.rstGH-timeout
(cherry picked from commit 95fb0e0258
2023-02-01 10:19:11 -08:00
c796d34b2a
[3.11] gh-101454: fix documentation for END_ASYNC_FOR ( #101455 ) ( #101493 )
...
gh-101454: fix documentation for END_ASYNC_FOR (#101455 )
(cherry picked from commit 62251c3da0
2023-02-01 14:30:48 +00:00
85cc5d0e5d
gh-98657: [docs] `array.typecodes` is a module-level attribute (GH-98729)
...
* gh-98657: [docs] `array.typecodes` is a module-level attribute
* Update array.rst
(cherry picked from commit c144e57b31
2023-01-31 21:48:19 -08:00
a79dd88973
gh-77607: Improve accuracy of os.path.join docs (GH-101406)
...
This is a follow-up to GH-100811.
One of the changes in that PR isn't accurate in that
`os.path.join('', '')` will not end in a separator.
This reverts that change to the previous wording that used "only", but
explicitly calls out the case where the last part ends in a separator,
which is what caused confusin in GH-77607 and motivated the change
in GH-100811.
(cherry picked from commit 909a674693
2023-01-30 21:46:48 -08:00
6a94f4c973
Fixes typo in asyncio.TaskGroup context manager code example (GH-101449)
...
(cherry picked from commit ef09bf63d2
2023-01-30 21:46:35 -08:00
6ec9f2d5b8
gh-101422: (docs) TarFile default errorlevel argument is 1, not 0 (GH-101424)
...
(cherry picked from commit ea232716d3
2023-01-30 10:10:26 -08:00
3bcb630e07
gh-98240: Updated Path.rename docs, when it is atomic (GH-98245)
...
(cherry picked from commit 0023f51deb
2023-01-29 17:52:29 -08:00
88a1e6db0f
[3.11] [doc] Add a section on logging handler configuration order. (GH-101380) (GH-101382)
...
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2023-01-27 19:12:18 +00:00
1016909a6d
[3.11] [doc] Add some notices to logging configuration documentation. (GH-101373) (GH-101376)
...
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2023-01-27 17:45:59 +00:00
4cf4169350
Added asyncio REPL example to docs. (GH-101243)
...
(cherry picked from commit 5d868efde9
2023-01-23 03:39:01 -08:00
69d12d868e
[3.11] GH-101097: Switch from standard interval notation to greater or less than signs for random.random()'s documentation (GH-101119) (GH-101246)
...
(cherry picked from commit 8bcd4a6ec7
2023-01-22 13:45:55 -08:00
db0eeb381e
[3.11] gh-86610: Use attribute directive in docs for pathlib.PurePath (GH-101114) ( #101205 )
...
(cherry picked from commit 01093b8203
2023-01-20 23:28:21 +01:00
efc89f3454
[3.11] GH-101111: Disambigaute origin of const for store_const and append_const (GH-101121) ( #101203 )
...
(cherry picked from commit 9a155138c5
2023-01-20 23:22:04 +01:00
1798df2b40
[3.11] Fix minor typos in SSL documentation (GH-101158) ( #101201 )
...
(cherry picked from commit 73497690b5
2023-01-20 23:18:25 +01:00
0dc35e4bbb
gh-91485: Avoid unnecessary use of non-Python syntax in io docs (GH-101177)
...
(cherry picked from commit 783d1bc51b
2023-01-20 14:12:26 -08:00
e039d53dae
[3.11] gh-101100: [Enum] Fix sphinx warnings in docs (GH-101122) ( #101173 )
...
(cherry picked from commit 9e025d305f
2023-01-20 23:07:23 +01:00
efe3a389ca
[3.11] gh-101144: Allow zipfile.Path .open & .read_text encoding to be positional ( #101179 )
...
The zipfile.Path open() and read_text() encoding parameter can be supplied as a positional argument without causing a TypeError again. 3.10.0b1 included a regression that made it keyword only.
Documentation update included as users writing code to be compatible with a wide range of versions will need to consider this for some time..
(cherry picked from commit 5927013e47
2023-01-20 00:06:18 -08:00
1998ea69c7
gh-101041: Fix a misspelled name of `utctimetuple` in a doc warning (GH-101042)
...
(cherry picked from commit 8e9d08b062
2023-01-19 21:06:47 -08:00
db65a326a4
Docs: improve sqlite3 placeholders example (GH-101092)
...
(cherry picked from commit b84be8d9c0
2023-01-18 01:43:44 -08:00
5e52778b1a
Fix typo in `ReprEnum` documentation (GH-101079)
...
(cherry picked from commit c5660ae96f
2023-01-17 02:59:35 -08:00
6d98282ed4
[3.11] Sync-up parameter name in equivalent code snippet of `enumerate` (GH-101029) ( #101030 )
...
Sync-up parameter name in equivalent code snippet of `enumerate` (GH-101029)
(cherry picked from commit ef633e5000
2023-01-15 12:16:06 +05:30
c7aa39286b
gh-100668: Clarify how sqlite3 maps parameters onto placeholders (GH-100960)
...
(cherry picked from commit 206f05a46b
2023-01-14 15:04:53 -08:00
39c1f68fff
gh-101021: Document binary parameters as bytes (GH-101024)
...
(cherry picked from commit 49cae39ef0
2023-01-14 12:22:08 -08:00
ba88628808
[3.11] Add recipes to showcase tee(), zip*, batched, starmap, and product. (GH-101028)
2023-01-13 22:32:32 -06:00
2834fdc689
[3.11] gh-100160: Tweak the documentation for the default asyncio policy (GH-100969)
2023-01-13 10:15:23 +02:00
75717645bc
Fix typo in `enum` module documentation (GH-100992)
...
(cherry picked from commit 2161bbf243
2023-01-12 07:51:11 -08:00
e8097d49f6
GH-100894: Updated the doc for `sys.winver` to clarify its usual contents (GH-100913)
...
(cherry picked from commit d9dff4c8b5
2023-01-11 16:21:07 -08:00
1b2459dc64
[3.11] gh-100160: Remove any deprecation warnings in asyncio.get_event_loop() ( #100412 )
...
Some deprecation warnings will reappear (in a slightly different form) in 3.12.
Co-authored-by: Guido van Rossum <guido@python.org>
2023-01-10 12:20:09 -08:00
1e74a12bde
[3.11] Fix typos in Doc folder (GH-100880). ( #100914 )
...
Co-authored-by: Semen Zhydenko <semen.zhydenko@gmail.com>
2023-01-10 11:42:03 +02:00
4e096ec647
bpo-28356: Document os.rename() behavior on Windows for differing volumes (GH-27376)
...
(cherry picked from commit e098137cd3
2023-01-09 13:52:43 -08:00
87076d880c
gh-100783: fix os.path.join documentation (GH-100811)
...
- Use "drive", not "drive letter", because of UNC paths
- Previous components are not thrown away from relative drive letters
- Use "segment" instead of "component" for consistency with pathlib
- Other miscellaneous improvements
(cherry picked from commit 53455a319f
2023-01-08 01:22:44 -08:00
caed845fb5
gh-100824: Fix typo in the documentation of unittest.TestLoader.testNamePatterns (GH-100825)
...
(cherry picked from commit 6d3bc4a795
2023-01-08 00:16:49 -08:00
4b4e6da7b5
[3.11] Future-proof recipe by renaming dotproduct() to sumprod() (GH-100828)
2023-01-07 15:16:38 -06:00
a3e2407f5c
gh-100673: Removed erroneous note in the get_type_hints docs (GH-100701)
...
Removed erroneous note in the get_type_hints docs
typing.get_type_hints still includes base class type hints.
(cherry picked from commit deaf090699
2023-01-07 09:38:32 -08:00
72263f2a20
gh-99026 update dataclasses docs for when annotations are inspected (gh-100798)
...
update dataclasses docs for when annotations are inspected
(cherry picked from commit 659c2607f5
2023-01-06 06:34:30 -08:00
d6b8413e94
gh-87691: clarify use of anchor in pathlib docs (GH-100782)
...
This is feedback from https://github.com/python/cpython/pull/100737GH-discussion_r1062968696
This matches the wording from the `os.path.join` docs better:
https://docs.python.org/3/library/os.path.htmlGH-os.path.join
In particular, the previous use of "anchor" was incorrect given the
pathlib definition of "anchor".
(cherry picked from commit 2f2fa03ff3
2023-01-05 17:59:27 -08:00
75861006d8
gh-87691: add an absolute path pathlib example in / operator docs (GH-100737)
...
The behaviour is fully explained a couple paragraphs above, but it may be useful to have a brief example to cover the behaviour.
(cherry picked from commit 1ae619c911
2023-01-05 15:04:39 -08:00
a34f0bdcf6
GH-100766: Note that locale.LC_MESSAGES is not universal (GH-100767)
...
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
2023-01-05 03:46:13 +00:00
7e9b2b0aa7
[Enum] docs: replace 'last value' by 'highest value' for Flag auto (GH-100709)
...
(cherry picked from commit 64ed609c53
2023-01-03 14:27:38 -08:00
af136e9877
gh-100428: Make int documentation more accurate (GH-100436)
...
- Remove first link to lexical definition of integer literal, since it
doesn't apply (differs in handling of leading zeros, base needs to be
explicitly specified, unicode digits are allowed)
- Better describe handling of leading zeros, unicode digits, underscores
- Base 0 does not work exactly as like a code literal, since it allows
Unicode digits. Link code literal to lexical definition of integer
literal.
(cherry picked from commit edfbf56f4c
2023-01-01 19:21:58 -08:00
e7a2659b4c
gh-99953: Purge mention of numeric param style from sqlite3 docs (GH-100630)
...
The PEP-249 numeric style has never been supported by sqlite3.
(cherry picked from commit b7a68ab824
2023-01-01 14:35:39 -08:00
c7dcfdaef6
gh-96773 Fix documentation of socket backlog (GH-96778)
...
(cherry picked from commit 1d1480fefc
2023-01-01 07:13:50 -08:00
7ed7127876
gh-100546: Remove incorrect positional-only marker from eval (GH-100547)
...
All the arguments are positional-only.
The current status after GH-99476 seems to be to not use positional-only
markers in documentation, hence I've simply removed it.
(cherry picked from commit 71159a8e07
2022-12-31 17:06:31 -08:00
18006309ea
[3.11] Improve comments in itertools uniquification recipes (GH-100631) (GH-100632)
2022-12-30 22:23:39 -06:00
297465a4db
gh-100616: Document 'attr' parameter for window.vline() in curses module (GH-24961)
...
(cherry picked from commit f4fcfdf8c5
2022-12-30 09:05:49 -08:00
e180dff4c7
gh-100583: Improve the `pydoc` documentation (GH-100590)
...
(cherry picked from commit 7223d50b97
2022-12-29 07:24:11 -08:00
ac31120de7
GH-100101: Clarify documentation of zip's strict option (GH-100103)
...
(cherry picked from commit cf1c098180
2022-12-28 13:32:19 -08:00
9120450b25
Restore early-out to factor(). Strengthen tests. (GH-100591)
...
(cherry picked from commit c4c5790120
2022-12-28 12:37:58 -08:00
95fa61cbce
Improve factor() recipe and fix its tests (GH-100576)
...
(cherry picked from commit 2d52406835
2022-12-28 03:22:11 -08:00
2cb4b13af6
[3.11] gh-92446: Improve argparse choices docs (GH-94627) ( #100528 )
...
Based on the definition of the collections.abc classes, it is more accurate to use "sequence" instead of "container" when describing argparse choices.
(cherry picked from commit ad3c99e521
2022-12-26 01:09:06 -06:00
44b664e057
gh-99535: Add test for inheritance of annotations and update documentation (GH-99990)
...
(cherry picked from commit f5b7b19bf1
2022-12-24 12:31:10 -08:00
f801fa8ee5
gh-100472: Fix docs claim that compileall parameters could be bytes (GH-100473)
...
(cherry picked from commit 046cbc2080
2022-12-24 12:29:50 -08:00
80013d78e0
[Minor PR] Quotes in documentation changed into code blocks (GH-99536)
...
Minor formatting fix in documentation
(cherry picked from commit efccd04b9e
2022-12-24 12:26:11 -08:00
3b70487459
GH-93179: Document the thread safety of functools.lru_cache (GH-95970)
...
(cherry picked from commit ba4bb7e464
2022-12-24 12:25:34 -08:00
bf0f306bcd
gh-100428: Make float documentation more accurate (GH-100437)
...
Previously, the grammar did not accept `float("10")`.
Also implement mdickinson's suggestion of removing the indirection.
(cherry picked from commit 2e1a9ce989
2022-12-24 12:18:40 -08:00
ba87dae453
Misc Itertools recipe tweaks (GH-100493)
...
(cherry picked from commit 0769f95751
2022-12-24 00:31:36 -08:00
b914054d9d
gh-77771: Add enterabs example in sched (GH-92716)
...
(cherry picked from commit 0f6420640c
2022-12-23 21:31:18 -08:00
a852c5f8ee
[3.11] Correct CVE-2020-10735 documentation (GH-100306). ( #100476 )
...
(cherry picked from commit 1cf3d78c92
2022-12-23 18:07:50 -08:00
9477594374
Add "strict" to dotproduct(). Add docstring. Factor-out common code. (GH-100480)
...
(cherry picked from commit f89de679ff
2022-12-23 16:00:21 -08:00
fe828ec709
gh-91081: Add note on WeakKeyDictionary behavior when deleting a replaced entry (GH-91499)
...
(cherry picked from commit c615286e85
2022-12-20 19:34:17 -08:00
23fa1667b3
gh-99991: improve docs on str.encode and bytes.decode (GH-100198)
...
(cherry picked from commit a2bb3b7f9d
2022-12-20 18:12:53 -08:00
1332fdabba
Clarify that every thread has its own default context in contextvars (GH-99246)
...
(cherry picked from commit cb60b6131b
2022-12-20 03:44:55 -08:00
cfa78ecc12
gh-69929: re docs: Add more specific definition of \w (GH-92015)
...
(cherry picked from commit 36a0b1d0dd
2022-12-19 19:14:52 -08:00
09186676cf
[3.11] GH-98363: Update batched() recipe in docs to match 3.12 ( #100323 )
2022-12-17 19:10:03 -06:00
e3d85783e5
Document that zipfile's pwd parameter is a `bytes` object (GH-100209)
...
(cherry picked from commit 5ee7eb9deb
2022-12-16 22:54:33 -08:00
4c810f92ba
gh-99830: asyncio: Document returns of remove_{reader,writer} (GH-100302)
...
(cherry picked from commit 5234e1cbea
2022-12-16 11:14:28 -08:00
9d2dcbbccd
[3.11] Remove uninformative itertools recipe (GH-100253) (GH-100275)
2022-12-15 12:47:58 -06:00
cb1001ce23
gh-100248: Add missing `ssl_shutdown_timeout` parameter in `asyncio` docs (GH-100249)
...
(cherry picked from commit 9663853800
2022-12-14 09:07:36 -08:00
cd4166fec2
GH-100206: use versionadded for the addition of sysconfig.get_default_scheme (GH-100207)
...
(cherry picked from commit d3ea82aaf9
2022-12-13 03:02:41 -08:00
60383a3cd8
Fix: typo (Indention) (GH-99904)
...
Example needed to be indented. Was trying to call a context manger `pr` (from ` with cProfile.Profile() as pr:`) wot perform ` pr.print_stats()` once it had already exited.
(cherry picked from commit 8711b59f7a
2022-12-12 04:38:39 -08:00
17bc55e043
clarify the 4300-digit limit on int-str conversion (GH-100175)
...
(cherry picked from commit 935ef59321
2022-12-12 04:06:48 -08:00
593c5a0247
gh-100174: [Enum] Correct PowersOfThree example. (GH-100178)
...
Changed from multiples of 3 to powers of 3 to match the class name.
(cherry picked from commit 868bab0fdc
2022-12-11 15:30:25 -08:00
606adb4b89
gh-99728: correct typo in `datetime` format codes documentation (GH-99750)
...
(cherry picked from commit d5f8a2b6ad
2022-12-10 02:29:04 -08:00
9aca00341a
gh-100049: fix `repr` for `mappingproxy` in dictionary view example doc (GH-100052)
...
(cherry picked from commit 7c0fb71fbf
2022-12-10 01:23:24 -08:00
ecb16d5d63
gh-96250: Improve sqlite3 injection attack example (GH-99270)
...
(cherry picked from commit 41d4ac9da3
2022-12-08 12:45:40 -08:00
3fae04b10e
[3.11] gh-93453: Only emit deprecation warning in asyncio.get_event_loop when a new event loop is created ( #99949 )
...
It no longer emits a deprecation warning if the current event loop was set.
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-12-06 16:15:44 +01:00
235f5fd2ca
[3.11] gh-100001: Remove doc typo, add versionadded (GH-100042) ( #100043 )
...
(cherry picked from commit bed15f87ea
2022-12-06 11:34:20 +01:00
05031ee1f5
[Enum] Fix typos in the documentation (GH-99960)
...
(cherry picked from commit 2ae894b6d1
2022-12-05 21:46:48 -08:00
a726f747e6
gh-100001: Omit control characters in http.server stderr logs. (GH-100002)
...
Replace control characters in http.server.BaseHTTPRequestHandler.log_message with an escaped \xHH sequence to avoid causing problems for the terminal the output is printed to.
(cherry picked from commit d8ab0a4dfa
2022-12-05 13:39:22 -08:00
f3a58cece6
[3.11] dataclasses.rst: Prevent horizontal scrolling (gh-100025) (gh-100028)
...
dataclasses.rst: Prevent horizontal scrolling (gh-100025)
(cherry picked from commit 51ee0a29e9
2022-12-05 13:59:34 -05:00
7f2bcc7aaa
gh-93464: [Enum] Add versionchanged tag (GH-99997)
...
(cherry picked from commit e3a3863cb9
2022-12-05 02:45:37 -08:00
27218d0799
gh-85747: "Preface" section of asyncio-eventloop.rst: Switch to active voice and suggest other edits (GH-99784)
...
(cherry picked from commit bf26bdf6ac
2022-12-03 16:59:06 -08:00
f4511d3ee9
[3.11] GH-98906 ```re``` module: ```search() vs. match()``` section should mention ```fullmatch()``` (GH-98916) (GH-99912)
...
GH-98906 ```re``` module: ```search() vs. match()``` section should mention ```fullmatch()``` (GH-98916)
Mention fullmatch along with search and match.
(cherry picked from commit e0f91deb59
2022-11-30 18:14:36 -05:00
90701ebaf4
bpo-47220: Document the optional callback parameter of weakref.WeakMethod (GH-25491)
...
(cherry picked from commit 9628136fac
2022-11-30 11:53:04 -08:00
d7c2e0a537
Docs: improve accuracy of socketserver reference (GH-24767)
...
(cherry picked from commit 052bc128ac
2022-11-29 12:43:09 -08:00
2e9ea7b44b
gh-90717: Update the documentation for the altchars paremeter in base64 library (GH-94187)
...
(cherry picked from commit 05dfc539c2
2022-11-29 08:29:03 -08:00
a2b84bbf77
`fnmatch` docs: link to `fnmatch.filter()`, not `builtins.filter()` (GH-99819)
...
(cherry picked from commit ca3e611b1f
2022-11-28 10:17:07 -08:00
1e327059a3
bpo-41825: restructure docs for the os.wait*() family (GH-22356)
...
(cherry picked from commit 492dc02b01
2022-11-28 01:48:52 -08:00
f160996412
Docs: both sqlite3 "point examples" now adapt to str (GH-99823)
...
(cherry picked from commit 276643e207
2022-11-27 13:21:00 -08:00
366adc7c83
gh-91340: Document multiprocessing.set_start_method force parameter (GH-32339)
...
GH-91340
https://bugs.python.org/issue47184
(cherry picked from commit dfc2732a57
2022-11-27 10:05:59 -08:00
8bb7fdaee8
doc: Remove backslashes in doctest grammar docs (GH-29346)
...
(cherry picked from commit 22860dbbc8
2022-11-26 22:46:33 -08:00
fe9957241a
gh-99795: Fix typo in importlib.resources.abc (GH-99796)
...
Changing TraversableReader to TraversableResources at one place of the documentation.
See GH-99795 for more details.
(cherry picked from commit 5f8898216e
2022-11-26 10:12:23 -08:00
f98322920e
[3.11] gh-99502: mention bytes-like objects as input in `secrets.compare_digest` (GH-99512) ( #99791 )
...
gh-99502: mention bytes-like objects as input in `secrets.compare_digest` (GH-99512)
Now it is in sync with https://docs.python.org/3/library/hmac.htmlGH-hmac.compare_digest
It is the same function, just re-exported. So, I guess they should mention the same input types.
(cherry picked from commit 47d673d81f
2022-11-26 15:19:23 +05:30
00755196e3
[3.11] Fix misspelling in docs for http.HTTPMethod (GH-99376) ( #99451 )
...
Fix misspelling in docs for http.HTTPMethod (GH-99376)
(cherry picked from commit f0d12ca0e0
2022-11-25 18:26:50 -05:00
f5fa17bef5
gh-64019: Have attribute table in `inspect` docs link to module attributes instead of listing them (GH-98116)
...
(cherry picked from commit 7d2dcc53d0
2022-11-25 14:06:45 -08:00
772fc63516
[3.11] gh-85073: Add some missing links to source (GH-99363) ( #99586 )
...
gh-85073: Add some missing links to source (GH-99363)
Add some missing links to source from Python docs
(cherry picked from commit 27d8dc2c9d
2022-11-25 23:19:40 +05:30
5b7408490f
gh-96168: Add sqlite3 row factory how-to (GH-99507)
...
(cherry picked from commit 8749121b07
2022-11-25 05:15:09 -08:00
609273eb52
gh-99619: fix error in documentation of ExceptionGroup.derive() (GH-99621)
...
(cherry picked from commit 5d9183c7ad
2022-11-23 03:08:22 -08:00
b4ae5b76ed
[3.11] gh-99650 : Updated argparse docs (GH-99653) (GH-99705)
2022-11-22 14:17:20 -08:00
a64e71eece
GH-92892: Add section about variadic functions to ctypes documentation (GH-99529)
...
On some platforms, and in particular macOS/arm64, the calling
convention for variadic arguments is different from the regular
calling convention. Add a section to the documentation to document
this.
(cherry picked from commit bc3a11d21d
2022-11-22 10:57:09 -08:00
420b7e8f43
[3.11] gh-99146 struct module documentation should have more predictable examples/warnings (GH-99141) (GH-99702)
...
gh-99146 struct module documentation should have more predictable examples/warnings (GH-99141)
* nail down a couple examples to have more predictable output
* update a number of things, but this is really just a stash...
* added an applications section to describe typical uses for native and machine-independent formats
* make sure all format strings use a format prefix character
* responding to comments from @gpshead. Not likely finished yet.
* This got more involved than I expected...
* respond to several PR comments
* a lot of wordsmithing
* try and be more consistent in use of ``x`` vs ``'x'``
* expand examples a bit
* update the "see also" to be more up-to-date
* original examples relied on import * so present all examples as if
* reformat based on @gpshead comment (missed before)
* responding to comments
* missed this
* one more suggested edit
* wordsmithing
(cherry picked from commit 22d91c16bb
2022-11-22 18:16:59 +00:00
05147dc383
gh-99662: fix typo in typing.TypeVarTuple docs (GH-99672)
...
(cherry picked from commit 1bf983ce7e
2022-11-21 20:09:49 -08:00
bb4c091583
[3.11] GH-95815: Document less specific error for os.remove (GH-99571) ( #99641 )
...
GH-95815: Document less specific error for os.remove (GH-99571)
os.remove can raise PermissionError instead of IsADirectoryError,
when the object to be removed is a directory (in particular on
macOS).
This reverts a change done in GH-14262.
(cherry picked from commit 1cae31d26b
2022-11-21 12:04:55 +01:00
a15ab1ec65
Doc: Make functions.html readable again. (GH-99476)
...
(cherry picked from commit 858cb79486
2022-11-19 02:58:32 -08:00
82ab9e6b79
gh-99553: fix bug where an ExceptionGroup subclass can wrap a BaseException (GH-99572)
...
(cherry picked from commit c8c6113398
2022-11-18 08:10:55 -08:00
51c68cf466
[3.11] gh-98930: improve the docstring of signal.strsignal (GH-99290) ( #99449 )
...
Improves the docstring on signal.strsignal to make it explain when it returns a message, None, or when it raises ValueError.
Closes GH-98930
Co-authored-by: Gregory P. Smith <greg@krypto.org>.
(cherry picked from commit 88385b8564
2022-11-13 12:21:19 -08:00
edf744990e
gh-99392: Fix sqlite3 converter recipes (GH-99393)
...
(cherry picked from commit dfc1b17a23
2022-11-12 11:48:52 -08:00
944ac46b88
[3.11] gh-99304: [Enum] clarify what constitutes a flag alias (GH-99395) (GH-99415)
...
gh-99304: [Enum] clarify what constitutes a flag alias (GH-99395)
(cherry picked from commit 73a921b070
2022-11-12 10:43:32 -08:00
d75b2e2fc8
gh-87604: Clarify in docs that sys.addaudithook is not for sandboxes (GH-99372)
...
(cherry picked from commit c3c3871415
2022-11-11 05:42:44 -08:00
17f1c0ab06
GH-99183: Document behavior of count() for empty substrings (GH-99339)
...
(cherry picked from commit 2f4af2d99c
2022-11-10 13:29:16 -08:00
014940ac70
Update reference to the size of PyPI (GH-99076)
...
Update reference to the size of PyPI
Last changed in 2008 (528576031d58ee5d8677
2022-11-09 11:36:10 -08:00
00147a84fc
gh-99238: clarify the type of the env dict. (GH-99253)
...
(cherry picked from commit 2eee9d9cd7
2022-11-08 13:09:04 -08:00
ca944628ac
Fix broken link in `asyncio-subprocesses` doc (GH-99214)
...
GH- Fix broken link in Doc/library/asyncio-subprocess.rst
This is a trivial fix in documentation to fix a broken link.
There is a broken link in [Doc/library/asyncio-subprocess.rst](https://docs.python.org/3/library/asyncio-subprocess.htmlGH-asyncio.subprocess.Process ) for the function ``wait_for``:
I suppose this refers to the function ``asyncio.wait_for`` which is not clear in the docs.
This PR fixes the link and the result looks like the following:
(cherry picked from commit acf4d5d5bd
2022-11-08 08:33:51 -08:00
2d00190591
gh-92119: ctypes: Print exception class name instead of its representation (GH-98302)
...
(cherry picked from commit b9dedfe61d
2022-11-07 21:20:06 -08:00
c4408d35f6
gh-94286 Fix documentation of print default param (GH-94297)
...
(cherry picked from commit 2db55e0c00
2022-11-06 12:24:02 -08:00
be4bab8c2b
gh-93464: [Enum] fix auto() failure during multiple assignment (GH-99148)
...
* fix auto() failure during multiple assignment
i.e. `ONE = auto(), 'text'` will now have `ONE' with the value of `(1,
'text')`. Before it would have been `(<an auto instance>, 'text')`
(cherry picked from commit 8feb7ab77c
2022-11-06 06:30:32 -08:00
07734a42db
[3.11] gh-98706: Sync with importlib_metadata 4.13.0. (GH-98875)
...
These changes are already applied to main but have been selected from importlib_metadata 4.x for their bug fixes.
2022-11-05 06:55:04 -07:00
f7d2c948f5
minor edits to locale doc (GH-98537)
...
(cherry picked from commit c0bf7607a1
2022-11-04 06:12:01 -07:00
2ef2eaac15
Docs: add `named` to the list of styles in the sqlite3.paramstyle attr docs (GH-99078)
...
(cherry picked from commit 016c7d37b6
2022-11-03 16:27:53 -07:00
eb023a84d9
gh-98740: Fix validation of conditional expressions in RE (GH-98764)
...
In very rare circumstances the JUMP opcode could be confused with the
argument of the opcode in the "then" part which doesn't end with the
JUMP opcode. This led to incorrect detection of the final JUMP opcode
and incorrect calculation of the size of the subexpression.
NOTE: Changed return value of functions _validate_inner() and
_validate_charset() in Modules/_sre/sre.c. Now they return 0 on success,
-1 on failure, and 1 if the last op is JUMP (which usually is a failure).
Previously they returned 1 on success and 0 on failure.
(cherry picked from commit e9ac890c02
2022-11-03 00:47:39 -07:00
2199a7dace
gh-65002: Make note that null bytes are used to pad bytes (GH-98635)
...
(cherry picked from commit 8cd21c2c5d
2022-11-02 19:24:24 -07:00
46ccb35a40
gh-92679: Clarify asyncio.loop.start_tls parameters (GH-92682)
...
(cherry picked from commit 898d0d9ad8
2022-11-01 22:12:52 -07:00
b2e28c8700
gh-92871: Postpone the removal of typing.{io,re} to 3.13 (GH-98958)
...
(cherry picked from commit 65d1407737
2022-11-01 21:00:13 -07:00
43cbb3df9a
Doc: Fix sphinx-lint issues (GH-98911)
...
They were introduced right between GH-98441 and GH-98408.
(cherry picked from commit c1c3be0f9d
2022-10-31 10:29:30 -07:00
f6f07b252f
gh-98576: Fix types in dataclass.InitVar example (gh-98577)
...
(cherry picked from commit 880bafc574
2022-10-31 08:14:04 -07:00
d038307b10
Fix typo in docs (GH-98863)
...
(cherry picked from commit bfecff5f73
2022-10-29 13:56:27 -07:00
e237bf6862
dataclasses docs: consistent indentation (4 spaces) in examples (GH-98855)
...
(cherry picked from commit d10c2b9742
2022-10-29 10:15:16 -07:00
12957d7cbd
Fix typo in contextvars docs (GH-98823)
...
(cherry picked from commit 72fa57a8fe
2022-10-28 14:23:26 -07:00
2d4b6e00f0
`argparse` docs: normalize constant references (GH-98765)
...
(cherry picked from commit b27b57c6e4
2022-10-28 05:25:58 -07:00
5f86275ec2
[3.11] Change links to label refs (GH-98454) ( #98725 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 268129a74f
2022-10-26 13:18:50 -07:00
78df56ec69
gh-98716: Revert gh-96081: Escape lone stars in sqlite3 docs (GH-98720)
...
(cherry picked from commit 365852a03a
2022-10-26 08:01:54 -07:00
ca266aaf45
gh-98644: point people to tomllib from configparser’s docs (GH-98645)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 5e74bad93c
2022-10-26 07:14:44 -07:00
2aedba59ec
gh-98348: Mention ReferenceError in weakref.proxy documentation (GH-98355)
...
(cherry picked from commit 216f45e4fe
2022-10-25 20:55:29 -07:00
7a25d27ec2
gh-77753: Add example for values that compare equal in stdtypes (GH-98497)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 0ca6a4d640
2022-10-25 20:02:44 -07:00
8777d059bb
gh-84747: Add `async for` comment for StreamReader (GH-98633)
...
(cherry picked from commit 4196ee5c8b
2022-10-25 19:23:08 -07:00
4fc042f28f
gh-97937: dis docs: add adaptive=False (GH-97939)
...
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Co-authored-by: Brandt Bucher <brandtbucher@gmail.com>
(cherry picked from commit 5d8bf2b106
2022-10-25 16:06:08 -07:00
4cd5ea62ac
gh-98602: [typing docs] Use quotes for forward reference in TypeVarTuple example (GH-98605)
...
(cherry picked from commit be0cf82ae4
2022-10-25 08:42:12 -07:00
4b68e34a6c
gh-98623: Fix base classes in `typing.rst` (GH-98626)
...
(cherry picked from commit 5076108872
2022-10-25 07:13:16 -07:00
b3cafb60af
[3.11] Fix v3.11.0 release merge problems (GH-98622)
...
When merging the v3.11.0 tag into 3.11, some files were incorrectly updated and some others were not properly deleted.
Automerge-Triggered-By: GH:pablogsal
2022-10-24 16:30:06 -07:00
69b6b56d85
Python 3.11.0
...
-----BEGIN PGP SIGNATURE-----
iQIzBAABCAAdFiEEz9yiRbEEPPKl+Xhl/+h0BBaL2EcFAmNWzOwACgkQ/+h0BBaL
2EcepxAAmZLGMrL4D7Zxzo6N2ezkuiuoQH4JvxIUaB7cjU5h0GSUFlmcJQCHhCwk
AvToQrmH/7uuuEZKST1fomtUE83wudfHhX2t+CMBdbLG1hIwhTfLNMTqFhONturF
XlkVUcva1i9XrYZPLl1pIcBf1Sjm6pPW5QZ4BP1ZHJ5C2pHEzaBRFX/q0lU5aF9O
z5nBBpnga2gShUTqM1VkXucU4lKXsi4blbn/Z8giganMXY1SXIsEOoCaDZYN1Hh/
xQiOpSrjy/uSz4vGSNuPwp9J2lRlw8n4RBd/P7om01CrJMAKotH+62OqwhlQ8ydB
ywp0kygtPtMdSK7F1WKMWkYX4CXfLpYwN0+x3Z3iYFBFiuzOFrUCQYgqqfEPNq+o
bQxxnhAvYcOVINUub6oL23hgFZIoM6l54L66qujQVFM0usCY2f23Ikqd0Z7K8+6e
uDRAvGiCHkbbfhdnfXzc/Wgj4zLaPnNs8S2s8ojK32NPV8gyWVBumcsRvlocfl6K
hoA5wqeAXsOv+pFjkGtk90Yg+8R9n+n47//o6uYW/vvZtksm2wPm3hnuCA0WqPzN
IM7SJE5VrtSRqQpXT9j4G3zyHDNT/Qhrh+cyBM5kgoPSdbU0ugZN8P7GWVtsFhmK
rrHRns85gNZJ6qTN1pU22MybYCPIsg5Dt6+jZ8hJWIzOOy9apIk=
=Ryd2
-----END PGP SIGNATURE-----
gpgsig -----BEGIN PGP SIGNATURE-----
iQIzBAABCAAdFiEEz9yiRbEEPPKl+Xhl/+h0BBaL2EcFAmNW55YACgkQ/+h0BBaL
2EfCLg//bMWtb/X3D+IM+9BIrpEscj/vw22zH9j8PIRd8iWfW80TNEIBh4uPEc0j
SDTkA5bqN6CB7xqIxDlWQcJpGiImVZ2LzOw8HHye1QCfVZk741CF78UhEnb+hTbO
gr7nIznytv+VdMSDRHTSgpnkRNQ9FjFEHLu7YQTMof5i/YmTxWZcsru6dTLlEutg
F3+PfxbKwPgJkfare91X62XSQwyTL6k0mvl5+Sdq2WEQdgMqv4I8V9dHbnk9K3VI
B+K2xsfIyWHrLDwQa3LBZj4YOKTwnwqlr1sEqO47NfasWaMYa1vBsktLVtPVQ3xS
Hz0lLhJXJLzf5hmf2r4Tw1S5spn5ijsZ7CwK2Zl+1+dbJMpRoK4VeSSYy/OfEpwy
8Hx1YitMyORF3HkGWa+pPYPNaIOw4S/EQQPYd5osg3NnknYjkkKZZaliq7EZra7c
GANPJamXhHREQyhux9KeiYZer3SU3CSXopyxm8ClcBZJAiAOjhAdeOk+Q4Ta9T6+
gRWBOrelroyFTWHsOd8V7gSz3XJNuAzlNZ/+1Oj/7Em+5DGLFcxJrZGLxn+hruZ5
GPK9IQXbURAuxqVrqCzw2tzf/NzJr0fs4QDYEVI95pfLjzk1tuJ5WR6zFNC0COK2
qw8TTvXglsvHqVMnK8u73GVSTv1UGYqbQH9uAeEikAQYr3TTdZo=
=dsZm
-----END PGP SIGNATURE-----
Merge tag 'v3.11.0' into 3.11
Python 3.11.0
2022-10-24 20:29:24 +01:00
cdbfce121f
gh-98507: [typing docs] Rephrase "now supports `[]`" to "now supports subscripting" (GH-98508)
...
(cherry picked from commit e3b9dd8e87
2022-10-24 11:16:58 -07:00
032d1276ed
GH-91635: clarify docs about closing of transport in asyncio (GH-98563)
...
(cherry picked from commit 2fdcc6f2cb
2022-10-24 11:00:18 -07:00
d9abd8a584
gh-98500: Fix typing docs for `*View` classes (GH-98511)
...
(cherry picked from commit 1a217f9ffc
2022-10-24 10:55:11 -07:00
981b509784
GH-90985: Revert "Deprecate passing a message into cancel()" (GH-97999)
...
Reason: we were too hasty in deprecating this.
We shouldn't deprecate it before we have a replacement.
(cherry picked from commit 09de8d7aaf
2022-10-24 17:09:41 +01:00
f0083923fa
gh-90908: Document asyncio.Task.cancelling() and asyncio.Task.uncancel() (GH-95253)
...
Co-authored-by: Thomas Grainger <tagrain@gmail.com>
(cherry picked from commit f00645d5db
2022-10-24 17:09:37 +01:00
ae68a45daa
gh-98561: Fix a typo in typing (GH-98562)
...
(cherry picked from commit b6d5d5b60a
2022-10-23 07:13:25 -07:00
bac61bc5b1
gh-95778: Mention sys.set_int_max_str_digits() in error message (GH-96874)
...
When ValueError is raised if an integer is larger than the limit,
mention sys.set_int_max_str_digits() in the error message.
(cherry picked from commit e841ffc915
2022-10-22 20:54:35 +01:00
f1ca2f6a41
[3.11] Docs: Fix backtick errors found by sphinx-lint (GH-97998) ( #98371 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>.
(cherry picked from commit fa2d43e518
2022-10-22 20:38:26 +01:00
f8f0386bb7
gh-95913: Copyedit & xref FrameInfo in Whatsnew inspect section (GH-98304)
...
(cherry picked from commit 8f30267ab4
2022-10-22 20:29:11 +01:00
519b56a5c7
gh-95913: Copyedit & xref FrameInfo in Whatsnew inspect section (GH-98304)
...
(cherry picked from commit 8f30267ab4
2022-10-22 12:21:01 -07:00
886fd3938b
gh-96706: [doc] Don't recomment deprecated use of get_event_loop() in examples (GH-96707)
...
(cherry picked from commit 53a54b781d
2022-10-22 20:06:17 +01:00
040bbd2ec6
gh-95778: Fix `sys.set_int_max_str_digits()` parameter name (GH-96798)
...
Discovered in https://github.com/python/typeshed/pull/8733
(cherry picked from commit bf5fd49252
2022-10-22 20:06:16 +01:00
6cce942bd3
Itertools sieve() recipe (GH-96813) (GH-96814)
2022-10-22 20:06:14 +01:00
99f5568498
gh-96702: Order methods before attrs in sqlite3.Connection docs (GH-96703) ( #96788 )
...
(cherry picked from commit 49cceeb5c9
2022-10-22 20:06:13 +01:00
746dad4eab
gh-96810: Clarify for which statements sqlite3 implicitly opens transactions (GH-96832)
...
(cherry picked from commit 16c33a9676
2022-10-22 20:06:12 +01:00
a955cccf7a
Clarify that the expression is regular math notation, not Python. (GH-96903) (GH-96908)
2022-10-22 20:06:11 +01:00
122a07c869
Simplify sieve() recipe. Add edge case tests. (GH-96892)
...
(cherry picked from commit 78359b1d45
2022-10-22 20:06:10 +01:00
1c345fa012
GH-96851: Add link to FAQ entry for caching method calls. (GH-96902)
...
(cherry picked from commit bbc24b2bd5
2022-10-22 20:06:09 +01:00
2a1e9b01d1
gh-96917: link to typing.readthedocs.io from typing.rst (GH-96921)
...
See the discussion at https://github.com/python/cpython/issues/91533
(cherry picked from commit 5b3a2569f4
2022-10-22 20:06:06 +01:00
6464096400
[3.11] gh-96727: Document restrictions on Handler.emit() with respect to locking. (GH-96948) (GH-96950)
...
(cherry picked from commit 6ad47b41a6
2022-10-22 20:06:05 +01:00
00e8a27dee
gh-77171: Document that wave only supports simple PCM files (GH-97510)
2022-10-22 20:06:02 +01:00
e65e6de0fb
GH-65046: Fix docs about logging in `asyncio` (GH-97559)
...
Explain that logging should not use network I/O.
(cherry picked from commit d68c37c0d0
2022-10-22 20:06:00 +01:00
50da78af68
gh-96959: Update more HTTP links (GH-97536)
...
Use HTTPS for documents which are available by both HTTP and HTTPS
links, but there is no redirection from HTTP to HTTPS or vice versa.
(cherry picked from commit dd53b79de0
2022-10-22 20:05:59 +01:00
2b0b017683
gh-96377: Update asyncio policy doc intro paras to be clear and accurate (GH-97603)
...
Also fix up some cross-references in the asyncio docs.
(cherry picked from commit cc0f3a10f0
2022-10-22 20:05:58 +01:00
f0cbc6c18e
fixup policy docs (GH-97618)
...
(cherry picked from commit 9a404b173e
2022-10-22 20:05:55 +01:00
68b7a6ab99
gh-52597: Add position-only markers for os functions (GH-94735)
...
(cherry picked from commit c759944f16
2022-10-22 20:05:54 +01:00
f20ad5ef45
gh-96397: Document that attributes need not be identifiers (GH-96454)
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 9a11ed8e50
2022-10-22 20:05:52 +01:00
c12c993aa1
gh-87597: Document TimeoutExpired.stdout & .stderr types (GH-97685)
...
This documents the behavior that has always been the case since timeout
support was introduced in Python 3.3.
(cherry picked from commit b05dd79649
2022-10-22 20:05:50 +01:00
b8afd5ffd3
Fix capitalization of Unix in documentation (GH-96913)
...
(cherry picked from commit bd7d0e875e
2022-10-22 20:05:49 +01:00
c8bdf339d7
GH-85447: Clarify docs about awaiting future multiple times (GH-97738)
...
(cherry picked from commit 9151bbefea
2022-10-22 20:05:45 +01:00
ce01c59b25
Fix typo in unittest docs (GH-97742)
...
(cherry picked from commit e6f9ec5c03
2022-10-22 20:05:41 +01:00
208701e037
multiprocessing docs: Remove extra option ELLIPSIS from section with code (GH-96625)
...
(cherry picked from commit d78aa4e11a
2022-10-22 20:05:40 +01:00
4f254f6120
Minor grammar changes to http.client docs (GH-96221)
...
Minor grammar changes
(cherry picked from commit d053c47bfd
2022-10-22 20:05:39 +01:00
fb0d9316ef
Update http.client.rst (GH-24803)
...
* Update http.client.rst
* Apply suggestions from code review
Co-authored-by: Éric <merwok@netwok.org>
* Update http.client.rst
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Senthil Kumaran <senthil@python.org>
(cherry picked from commit 0c91a12511
2022-10-22 20:05:38 +01:00
c6bf822a89
GH-82604: fix docs about configuring selector (GH-97755)
...
(cherry picked from commit 53503ff60e
2022-10-22 20:05:34 +01:00
7ddd0d3194
gh-90301: Doc: Add references to PEP 686 (GH-96816)
...
Doc: Add references to PEP 686.
(cherry picked from commit 87679a6e60
2022-10-22 20:05:32 +01:00
ed772a817e
[3.11] gh-96448: fix documentation for _thread.lock.acquire (GH-96449) ( #97851 )
...
gh-96448: fix documentation for _thread.lock.acquire (GH-96449)
* fix documentation for _thread.lock.acquire
* update formatting of _thread.lock.acquire() doc
(cherry picked from commit 7acb93f0d4
2022-10-22 20:05:31 +01:00
95f7ed8b07
[3.11] gh-88355: Fix backslashes in AF_PIPE (GH-96543) ( #97854 )
...
gh-88355: Fix backslashes in AF_PIPE (GH-96543)
Fix backslashes in AF_PIPE (GH-88355)
The correct syntax for AF_PIPE addresses is `\\.\pipe\blahblah`, not `\.\pipe{blahblah}`, but the syntax markup messed up the backslashes.
(cherry picked from commit ff28d8926d
2022-10-22 20:05:30 +01:00
12bd7e9258
Add re.VERBOSE flag documentation example (GH-97678)
...
The current re.VERBOSE documentation example leaves space for ambiguous
interpretation. One may read that spaces within the `(?:` token are
spaces inside the non-capturing group (such as `(?: )`). This patch
removes the ambiguity by including examples after the statement.
(cherry picked from commit 0ceafa7fa4
2022-10-22 20:05:18 +01:00
5f43097616
gh-97661: Improve accuracy of sqlite3.Cursor.fetchone docs (GH-97662)
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 4b83cd0b22
2022-10-22 20:05:17 +01:00
800c9c0610
[3.11] gh-93738: Documentation C syntax (:c:type:`PyObject` -> :c:expr:`PyObject`) (GH-97776) ( #97889 )
...
:c:type:`PyObject` -> :c:expr:`PyObject`
(cherry picked from commit 0bf6a617ed
2022-10-22 20:05:16 +01:00
33e4537975
[3.11] gh-93738: Documentation C syntax (Use `c:struct`) (GH-97772) ( #97869 )
...
Use `c:struct`
(cherry picked from commit a0f5599aac
2022-10-22 20:05:14 +01:00
c5d6009c41
GH-95172 Make the same version `versionadded` oneline (GH-95172)
...
* Make the same version versionadded oneline
* Format versionadded for enum.rst
* Format versionadded
A single line versionadded was reading better.
Co-authored-by: Senthil Kumaran <senthil@python.org>
(cherry picked from commit d6062d1170
2022-10-22 20:05:11 +01:00
28f97dc9d2
docs(typing): add "see PEP 675" to LiteralString (GH-97926)
...
(cherry picked from commit 2016bc54a2
2022-10-22 20:05:11 +01:00
e48d6dfbcd
[3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) ( #97924 )
...
:c:type:`<C type>` -> :c:expr:`<C type>`
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 0031e62973
2022-10-22 20:05:10 +01:00
2af22d2205
[3.11] gh-96197: Fix expression when :func:`sys.breakpointhook is missing (gh-96293) ( #96294 )
...
(cherry picked from commit 47d406ffc4
2022-10-22 20:05:08 +01:00
bf50f10a6d
GH-88968: Add notes about socket ownership transfers (GH-97936)
...
(cherry picked from commit 74ea204634
2022-10-22 20:05:07 +01:00
508ef0f343
[3.11] gh-95691: Doc BufferedWriter and BufferedReader (GH-95703) ( #97947 )
...
gh-95691: Doc BufferedWriter and BufferedReader (GH-95703)
(cherry picked from commit 0d68879104
2022-10-22 20:05:06 +01:00
3652b26ba1
Misc updates to the itertools recipes and tests (GH-98018)
...
(cherry picked from commit e500cc0451
2022-10-22 20:04:59 +01:00
a8a33e16e3
gh-71316: Update dis documentation to include changes to jump arguments (GH-95798)
...
(cherry picked from commit 6592a62ec2
2022-10-22 20:04:58 +01:00
40527c2b19
gh-64921: Clarify wording for open()'s newline arg (GH-96171)
...
(cherry picked from commit 4a74e6ab38
2022-10-22 20:04:57 +01:00
c634cd2d8c
[3.11] gh-91708: Revert params note in urllib.parse.urlparse table (GH-96699) ( #98052 )
...
Revert params note in urllib.parse.urlparse table
(cherry picked from commit eed80458e8
2022-10-22 20:04:55 +01:00
e32c7364c6
gh-61105: Add default param, note on using cookiejar subclass (GH-95427)
...
(cherry picked from commit 5eaf4d6101
2022-10-22 20:04:54 +01:00
dfae46c665
gh-97822: Fix http.server documentation reference to test() function (GH-98027)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 6b485629d2
2022-10-22 20:04:53 +01:00
9f3aaef854
gh-56133: copyreg docs: Clarify function/constructor parameter (GH-95497)
...
(cherry picked from commit 281a3f18cc
2022-10-22 20:04:50 +01:00
1f58d8ce78
gh-83940: os docs: Improve wording for getenv/getenvb (GH-98113)
...
(cherry picked from commit 187e853690
2022-10-22 20:04:47 +01:00
e69136baff
[3.11] gh-88452: Add a warning about non-portability of environments. (GH-98155) (GH-98157)
2022-10-22 20:04:46 +01:00
Miss Islington (bot)
