Commit Graph

11345 Commits

Author SHA1 Message Date
Miss Islington (bot) 85f88f63d9
Fix typo in contextvars docs (GH-98823)
(cherry picked from commit 72fa57a8fe)

Co-authored-by: cburroughs <chris.burroughs@gmail.com>
2022-10-28 14:19:43 -07:00
Alex Waygood 4320115613
[3.10] `argparse` docs: normalize constant references (#98765) (#98808)
`argparse` docs: normalize constant references (#98765)

(cherry picked from commit b27b57c6e4)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
2022-10-28 18:17:03 +01:00
Erlend E. Aasland 4b41b11a63
[3.10] gh-98716: Revert gh-96081: Escape lone stars in sqlite3 docs (GH-98720) (#98737)
(cherry picked from commit 365852a03a)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-10-26 22:19:20 +02:00
Miss Islington (bot) 5e08585317
gh-98348: Mention ReferenceError in weakref.proxy documentation (GH-98355)
(cherry picked from commit 216f45e4fe)

Co-authored-by: fancidev <fancidev@gmail.com>
2022-10-25 20:55:29 -07:00
Miss Islington (bot) 0f93725063
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)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-25 20:01:11 -07:00
Miss Islington (bot) 866dc74afa
gh-84747: Add `async for` comment for StreamReader (GH-98633)
(cherry picked from commit 4196ee5c8b)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-25 19:23:08 -07:00
Miss Islington (bot) 3e335f2c0d
gh-98623: Fix base classes in `typing.rst` (GH-98626)
(cherry picked from commit 5076108872)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2022-10-25 07:15:07 -07:00
Miss Islington (bot) d79a42aac8
gh-98507: [typing docs] Rephrase "now supports `[]`" to "now supports subscripting" (GH-98508)
(cherry picked from commit e3b9dd8e87)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2022-10-24 11:17:33 -07:00
Miss Islington (bot) 39e914c03a
GH-91635: clarify docs about closing of transport in asyncio (GH-98563)
(cherry picked from commit 2fdcc6f2cb)

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-10-24 11:01:37 -07:00
Miss Islington (bot) e69509f468
gh-98500: Fix typing docs for `*View` classes (GH-98511)
(cherry picked from commit 1a217f9ffc)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2022-10-24 10:54:35 -07:00
Miss Islington (bot) f3c23fc48c
gh-98561: Fix a typo in typing (GH-98562)
(cherry picked from commit b6d5d5b60a)

Co-authored-by: Omkaar <79257339+Infiniticity@users.noreply.github.com>
2022-10-23 07:11:29 -07:00
Miss Islington (bot) dcb342b5f9
gh-51511: Note that codecs.open()'s encoding parameter affects automatic conversion to binary mode (GH-94370)
(cherry picked from commit d9407b174c)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-21 16:28:25 -07:00
Vinay Sajip dddbbd9e3e
[3.10] [doc] Refresh the venv introduction documentation, and correct… (GH-98466)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Phil Elson <pelson.pub@gmail.com>
2022-10-19 22:56:26 +01:00
C.A.M. Gerlach b2db1c2080
[3.10] Docs: Fix backtick errors found by sphinx-lint (GH-97998) (#98373)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>.
(cherry picked from commit fa2d43e518)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-10-18 01:49:47 +02:00
Miss Islington (bot) 26307384ff
gh-85299: Add note warning about entry point guard for asyncio example (GH-93457)
(cherry picked from commit 79fd6ccdbe)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-16 10:13:28 -07:00
Jelle Zijlstra 8a1f1cbe1a
[3.10] docs(typing): harmonize "See PEP x for more details" (GH-97927). (#98293)
(cherry picked from commit 02389658a4)

Co-authored-by: Simon Legner <Simon.Legner@gmail.com>
2022-10-15 21:08:46 -07:00
Miss Islington (bot) bd73110959
gh-65046: Link to logging cookbook from asyncio docs (GH-98207)
(cherry picked from commit c39a0c3354)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-10-11 21:50:15 -07:00
Miss Islington (bot) f6abb332a2
Formatting fixes in contextlib docs (GH-98111)
(cherry picked from commit 3b33c2010a)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-11 21:06:40 -07:00
Miss Islington (bot) 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)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-10-11 19:48:39 -07:00
Miss Islington (bot) 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
Miss Islington (bot) de745870e6
gh-83940: os docs: Improve wording for getenv/getenvb (GH-98113)
(cherry picked from commit 187e853690)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-10 07:01:17 -07:00
Miss Islington (bot) ac0a19b62a
gh-56133: copyreg docs: Clarify function/constructor parameter (GH-95497)
(cherry picked from commit 281a3f18cc)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-09 18:34:53 -07:00
Miss Islington (bot) 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)

Co-authored-by: JasonYZ <yurenzhang2017@gmail.com>
2022-10-07 23:57:31 -07:00
Miss Islington (bot) 1818235f40
gh-57179: Add note on symlinks for os.walk (GH-94799)
(cherry picked from commit 0f498f1a95)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-07 20:15:08 -07:00
Miss Islington (bot) 1a31799d16
gh-61105: Add default param, note on using cookiejar subclass (GH-95427)
(cherry picked from commit 5eaf4d6101)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-07 19:00:35 -07:00
Miss Islington (bot) 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)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-07 16:02:43 -07:00
Miss Islington (bot) e73cb54a06
gh-65496: Correct wording on csv's skipinitialspace argument (GH-96170)
(cherry picked from commit 676d8ef380)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-07 12:30:39 -07:00
Miss Islington (bot) 5054ae23ce
gh-64921: Clarify wording for open()'s newline arg (GH-96171)
(cherry picked from commit 4a74e6ab38)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-10-07 11:21:44 -07:00
Christopher Chianelli 5e87cc2ab5
[3.10] gh-71316: Update dis documentation to include changes to jump arguments (GH-95798). (GH-98029)
(cherry picked from commit 6592a62ec2)

Co-authored-by: Christopher Chianelli <cchianel@redhat.com>
2022-10-07 15:35:41 +01:00
Miss Islington (bot) 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)

Co-authored-by: 180909 <734461790@qq.com>

Co-authored-by: 180909 <734461790@qq.com>
2022-10-05 17:22:42 -07:00
Miss Islington (bot) c80c282d11
GH-88968: Add notes about socket ownership transfers (GH-97936)
(cherry picked from commit 74ea204634)

Co-authored-by: Guido van Rossum <guido@python.org>
2022-10-05 16:54:46 -07:00
Łukasz Langa 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)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-05 14:10:55 -07:00
Łukasz Langa 9aed6bdb20
[3.10] gh-93738: Documentation C syntax (Use `c:struct`) (GH-97772) (#97893)
Use `c:struct`
(cherry picked from commit a0f5599aac)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-05 08:20:46 -07:00
Miss Islington (bot) 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)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-05 08:17:46 -07:00
Miss Islington (bot) 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)

Co-authored-by: Jia Junjie <62194633+jiajunjie@users.noreply.github.com>
2022-10-05 01:56:47 -07:00
Miss Islington (bot) 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)

Co-authored-by: Athos Ribeiro <athoscribeiro@gmail.com>
2022-10-04 18:37:01 -07:00
Miss Islington (bot) 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)

Co-authored-by: cousteau <cousteaulecommandant@users.noreply.github.com>

Co-authored-by: cousteau <cousteaulecommandant@users.noreply.github.com>
2022-10-04 15:55:39 -07:00
Miss Islington (bot) 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)

Co-authored-by: Daniel Giger <danielg3432@gmail.com>

Co-authored-by: Daniel Giger <danielg3432@gmail.com>
2022-10-04 15:21:38 -07:00
Miss Islington (bot) f4e2686b78
GH-82604: fix docs about configuring selector (GH-97755)
(cherry picked from commit 53503ff60e)

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-10-04 09:52:35 -07:00
Miss Islington (bot) 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)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2022-10-03 16:35:17 -07:00
Miss Islington (bot) 280bf3fb16
Minor grammar changes to http.client docs (GH-96221)
Minor grammar changes
(cherry picked from commit d053c47bfd)

Co-authored-by: Rohan Shah <57906961+rshah713@users.noreply.github.com>
2022-10-03 16:30:14 -07:00
Miss Islington (bot) f8a3c4cb83
Document that MozillaCookieJar works for curl's cookie files (GH-91852)
MozillaCookieJar works for curl's cookies
(cherry picked from commit 0ea8b925d0)

Co-authored-by: Boris Verkhovskiy <boris.verk@gmail.com>
2022-10-03 16:00:40 -07:00
Miss Islington (bot) 17b49be003
multiprocessing docs: Remove extra option ELLIPSIS from section with code (GH-96625)
(cherry picked from commit d78aa4e11a)

Co-authored-by: Ivan Kapeykin <5349983@gmail.com>
2022-10-03 15:49:16 -07:00
Miss Islington (bot) e1cbb6f62f
Fix typo in unittest docs (GH-97742)
(cherry picked from commit e6f9ec5c03)

Co-authored-by: annonm <annonm@gmail.com>
2022-10-03 06:42:42 -07:00
Jason R. Coombs 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
Miss Islington (bot) 72d445a22e
GH-85447: Clarify docs about awaiting future multiple times (GH-97738)
(cherry picked from commit 9151bbefea)

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-10-02 15:24:29 -07:00
Miss Islington (bot) 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)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2022-10-01 18:24:55 -07:00
Miss Islington (bot) 748b2b780d
Fix capitalization of Unix in documentation (GH-96913)
(cherry picked from commit bd7d0e875e)

Co-authored-by: Will Hawkins <8715530+hawkinsw@users.noreply.github.com>
2022-10-01 16:51:42 -07:00
Miss Islington (bot) 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)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2022-09-30 10:53:07 -07:00
Miss Islington (bot) 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)

Co-authored-by: Jeff Allen <ja.py@farowl.co.uk>
2022-09-29 16:25:29 -07:00