48447d44ed
gh-96130: Rephrase use of "typecheck" verb for clarity (GH-98144)
...
I'm sympathetic to the issue report, especially in case this helps
clarify to new users that Python itself does not do type checking at runtime
(cherry picked from commit ed6344eed0
2022-10-11 19:48:39 -07:00
bf6b52ebad
[3.10] gh-88452: Add a warning about non-portability of environments. (GH-98155) (GH-98156)
2022-10-10 21:09:27 +01:00
de745870e6
gh-83940: os docs: Improve wording for getenv/getenvb (GH-98113)
...
(cherry picked from commit 187e853690
2022-10-10 07:01:17 -07:00
ac0a19b62a
gh-56133: copyreg docs: Clarify function/constructor parameter (GH-95497)
...
(cherry picked from commit 281a3f18cc
2022-10-09 18:34:53 -07:00
786fde5d70
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-07 23:57:31 -07:00
1818235f40
gh-57179: Add note on symlinks for os.walk (GH-94799)
...
(cherry picked from commit 0f498f1a95
2022-10-07 20:15:08 -07:00
1a31799d16
gh-61105: Add default param, note on using cookiejar subclass (GH-95427)
...
(cherry picked from commit 5eaf4d6101
2022-10-07 19:00:35 -07:00
02394400f3
[3.10] gh-91708: Revert params note in urllib.parse.urlparse table (GH-96699) ( #98053 )
...
Revert params note in urllib.parse.urlparse table
(cherry picked from commit eed80458e8
2022-10-07 16:02:43 -07:00
e73cb54a06
gh-65496: Correct wording on csv's skipinitialspace argument (GH-96170)
...
(cherry picked from commit 676d8ef380
2022-10-07 12:30:39 -07:00
5054ae23ce
gh-64921: Clarify wording for open()'s newline arg (GH-96171)
...
(cherry picked from commit 4a74e6ab38
2022-10-07 11:21:44 -07:00
5e87cc2ab5
[3.10] gh-71316: Update dis documentation to include changes to jump arguments (GH-95798). (GH-98029)
...
(cherry picked from commit 6592a62ec2
2022-10-07 15:35:41 +01:00
e2591e4f5e
[3.10] gh-95691: Doc BufferedWriter and BufferedReader (GH-95703) ( #97948 )
...
gh-95691: Doc BufferedWriter and BufferedReader (GH-95703)
(cherry picked from commit 0d68879104
2022-10-05 17:22:42 -07:00
c80c282d11
GH-88968: Add notes about socket ownership transfers (GH-97936)
...
(cherry picked from commit 74ea204634
2022-10-05 16:54:46 -07:00
3b0f2a7ff0
[3.10] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) ( #97925 )
...
:c:type:`<C type>` -> :c:expr:`<C type>`
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 0031e62973
2022-10-05 14:10:55 -07:00
9aed6bdb20
[3.10] gh-93738: Documentation C syntax (Use `c:struct`) (GH-97772) ( #97893 )
...
Use `c:struct`
(cherry picked from commit a0f5599aac
2022-10-05 08:20:46 -07:00
4245764fae
[3.10] gh-93738: Documentation C syntax (:c:type:`PyObject` -> :c:expr:`PyObject`) (GH-97776) ( #97888 )
...
:c:type:`PyObject` -> :c:expr:`PyObject`
(cherry picked from commit 0bf6a617ed
2022-10-05 08:17:46 -07:00
3c09debaa7
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-05 01:56:47 -07:00
24908f1f20
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-04 18:37:01 -07:00
a980dafd2c
[3.10] gh-88355: Fix backslashes in AF_PIPE (GH-96543) ( #97855 )
...
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-04 15:55:39 -07:00
f9b49b6bfa
[3.10] gh-96448: fix documentation for _thread.lock.acquire (GH-96449) ( #97852 )
...
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-04 15:21:38 -07:00
f4e2686b78
GH-82604: fix docs about configuring selector (GH-97755)
...
(cherry picked from commit 53503ff60e
2022-10-04 09:52:35 -07:00
656983741f
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-03 16:35:17 -07:00
280bf3fb16
Minor grammar changes to http.client docs (GH-96221)
...
Minor grammar changes
(cherry picked from commit d053c47bfd
2022-10-03 16:30:14 -07:00
f8a3c4cb83
Document that MozillaCookieJar works for curl's cookie files (GH-91852)
...
MozillaCookieJar works for curl's cookies
(cherry picked from commit 0ea8b925d0
2022-10-03 16:00:40 -07:00
17b49be003
multiprocessing docs: Remove extra option ELLIPSIS from section with code (GH-96625)
...
(cherry picked from commit d78aa4e11a
2022-10-03 15:49:16 -07:00
e1cbb6f62f
Fix typo in unittest docs (GH-97742)
...
(cherry picked from commit e6f9ec5c03
2022-10-03 06:42:42 -07:00
bead571e6a
[3.10] gh-96845: Fix docs around importlib.abc.Traversable (GH-97515)
...
* [3.10] gh-96845: Correct reference to Traversable* classes.
* [3.10] gh-96845: Add a note about the pending move of resources.abcs.
2022-10-03 09:11:06 -04:00
72d445a22e
GH-85447: Clarify docs about awaiting future multiple times (GH-97738)
...
(cherry picked from commit 9151bbefea
2022-10-02 15:24:29 -07:00
a4fbb94965
gh-95588: Drop the safety claim from `ast.literal_eval` docs. (GH-95919)
...
It was never really safe and this claim conflicts directly with the big warning in the docs about it being able to crash the interpreter.
(cherry picked from commit 8baef8ae36
2022-10-01 18:24:55 -07:00
748b2b780d
Fix capitalization of Unix in documentation (GH-96913)
...
(cherry picked from commit bd7d0e875e
2022-10-01 16:51:42 -07:00
6d7dbcc0b3
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-09-30 10:53:07 -07:00
0688f110a6
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-09-29 16:25:29 -07:00
13f23e013d
fixup policy docs (GH-97618)
...
(cherry picked from commit 9a404b173e
2022-09-28 10:44:04 -07:00
0a7d4359be
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-09-27 17:33:58 -07:00
2e315d87ff
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-09-27 04:16:23 -07:00
6a41d11657
[3.10] gh-97567: Fixup cached_statements default value in sqlite3.connect docs ( #97568 )
...
This docs inconsistency was introduced by the 3.10 backport of gh-94629: gh-94646
2022-09-27 09:25:13 +02:00
72a78152f3
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-09-26 15:37:38 -07:00
437032e313
gh-96959: Update HTTP links which are redirected to HTTPS (GH-96961)
...
(cherry picked from commit db39050396
2022-09-25 01:20:53 -07:00
2a50772b63
gh-77171: Document that wave only supports simple PCM files (GH-97510)
...
(cherry picked from commit dc9065f8c2
2022-09-23 06:04:46 -07:00
96739bccf2
[3.10] gh-68966: Make mailcap refuse to match unsafe filenames/types/params (GH-91993) (GH-93543)
...
* gh-68966: Make mailcap refuse to match unsafe filenames/types/params (GH-91993)
(cherry picked from commit b9509ba7a9
2022-09-20 13:12:35 +02:00
7b6021b060
[3.10] gh-96917: link to typing.readthedocs.io from typing.rst (GH-96921) (GH-96937)
...
See the discussion at https://github.com/python/cpython/issues/91533 .
(cherry picked from commit 5b3a2569f4
2022-09-20 18:15:48 +08:00
7a8ac38b2b
[3.10] gh-96727: Document restrictions on Handler.emit() with respect to locking. (GH-96948) (GH-96951)
...
(cherry picked from commit 6ad47b41a6
2022-09-20 09:54:31 +01:00
ce11f39de5
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-09-16 11:30:05 -07:00
ec08534f95
gh-96810: Clarify for which statements sqlite3 implicitly opens transactions (GH-96832)
...
(cherry picked from commit 16c33a9676
2022-09-15 14:20:25 -07:00
7528e2c06c
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-09-13 09:45:18 -07:00
fbc768ff68
[3.10] gh-96702: Order methods before attrs in sqlite3.Connection docs (GH-96703). ( #96789 )
...
(cherry picked from commit 49cceeb5c9
2022-09-13 10:47:13 +02:00
9b710581a3
gh-94972: document that shield users need to keep a reference to their task (GH-96724)
...
Co-authored-by: Thomas Grainger <tagrain@gmail.com>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
(cherry picked from commit 6281affee6
2022-09-10 07:57:44 -07:00
6ee7a6b947
[3.10] gh-88287: Add BufferingFormatter documentation. (GH-96608) (GH-96674)
2022-09-08 08:33:16 +01:00
5caff8ec38
[doc] Update example in traceback doc (GH-96600) (GH-96605)
...
This Monty Python reference is of-its-time. It could seem inappropriate in the context of today's sensibilities around mental health.
Automerge-Triggered-By: GH:iritkatriel
(cherry picked from commit c4999f261f
2022-09-07 12:56:25 +01:00
e13f49a0bc
[3.10] gh-84095: Fill documentation gap regarding user-defined objects. (GH-… (GH-96576)
2022-09-05 08:21:22 +01:00
Miss Islington (bot)