Miss Islington (bot)
0a2b63f6ad
[3.10] gh-96931: Fix incorrect results in ssl.SSLSocket.shared_ciphers (GH-96932) ( #102919 )
...
gh-96931: Fix incorrect results in ssl.SSLSocket.shared_ciphers (GH-96932)
(cherry picked from commit af9c34f6ef )
Co-authored-by: Benjamin Fogle <benfogle@gmail.com>
2023-03-24 13:33:32 +01:00
Miss Islington (bot)
77e54fe98a
gh-98239: Document that inspect.getsource() can raise TypeError (GH-101689)
...
(cherry picked from commit b6132085ca )
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-03-23 12:41:50 -07:00
Miss Islington (bot)
6c667d025a
gh-102936: typing: document performance pitfalls of protocols decorated with @runtime_checkable (GH-102937)
...
(cherry picked from commit 58d2b30c01 )
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-23 11:28:11 -07:00
Miss Islington (bot)
3c2a7bb6b5
Docs: improve accuracy of sqlite3.Connection.interrupt() (GH-102904)
...
(cherry picked from commit 7b2d53dacc )
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-22 04:59:56 -07:00
Miss Islington (bot)
2e0505a1d9
Docs: improve the accuracy of the sqlite3.connect() timeout param (GH-102900)
...
(cherry picked from commit c24f1f1e87 )
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-22 04:49:32 -07:00
Miss Islington (bot)
00b50606c0
Docs: improve accuracy of pdb alias example (GH-102892)
...
(cherry picked from commit e0c63b7267 )
Co-authored-by: gaogaotiantian <gaogaotiantian@hotmail.com>
2023-03-22 04:41:54 -07:00
Miss Islington (bot)
eaafea86a0
gh-102595: Document PyObject_Format c-api function (GH-102596)
...
(cherry picked from commit 910a64e301 )
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Def: https://github.com/python/cpython/blame/5ffdaf748d98da6065158534720f1996a45a0072/Include/abstract.hGH-L389
2023-03-22 02:32:08 -07:00
Miss Islington (bot)
21b94028ef
Add link to sys.exit function documentation (GH-102805)
...
* Add link to `sys.exit` function documentation
* Update Doc/library/os.rst
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* Update Doc/library/os.rst
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
---------
(cherry picked from commit 41ef502d74 )
Co-authored-by: David Poirier <1152277+david-poirier@users.noreply.github.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-21 15:05:32 -07:00
Miss Islington (bot)
99b38bebfd
[3.10] Fix outdated note about 'int' rounding or truncating (GH-102736) ( #102767 )
...
Fix outdated note about 'int' rounding or truncating (GH-102736)
(cherry picked from commit 405739f916 )
Co-authored-by: Mark Dickinson <dickinsm@gmail.com>
2023-03-16 20:43:03 +00:00
Miss Islington (bot)
bef189b5c7
gh-101100: Documenting --prefix and --exec-prefix. (GH-102695)
...
(cherry picked from commit 61b9ff35cb )
Co-authored-by: Julien Palard <julien@palard.fr>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2023-03-15 15:14:00 -07:00
Hugo van Kemenade
087fb56b9d
[3.10] Remove misformatted exclamation marks in docs (GH-102694) ( #102717 )
...
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:26:46 +02:00
Miss Islington (bot)
95fd2dfd3f
gh-102703: Fix typo in modules tutorial documentation (GH-102707)
...
**Before**
This prevents directories with a common name, such as ``string``, unintentionally hiding ...
**After**
This prevents directories with a common name, such as ``string``, from unintentionally hiding ...
(cherry picked from commit 0a539b5db3 )
Co-authored-by: Robert Prater (B. Eng) <robcprater@gmail.com>
2023-03-14 17:10:39 -07:00
Miss Islington (bot)
df38f7c577
[3.10] gh-102354: change python3 to python in docs examples (GH-102696) ( #102698 )
...
gh-102354: change python3 to python in docs examples (GH-102696)
(cherry picked from commit 80abd62647 )
Co-authored-by: Paul Watson <paul.hermeneutic@gmail.com>
2023-03-14 12:52:27 -06:00
Miss Islington (bot)
2c015a674d
gh-100315: clarification to __slots__ docs. (GH-102621)
...
refer to tp_itemsize in discussion on "variable-length" built-in types
(cherry picked from commit 88c262c086 )
Co-authored-by: T <tnie@tuta.io>
2023-03-14 02:30:28 -07:00
Miss Islington (bot)
125f75cc13
doc: Remove a duplicate 'versionchanged' in library/asyncio-task (gh-102677)
...
(cherry picked from commit 7bdb331b67 )
Co-authored-by: Joongi Kim <me@daybreaker.info>
2023-03-13 19:26:24 -07:00
Miss Islington (bot)
0275b12a0f
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 )
Co-authored-by: Blind4Basics <32236948+Blind4Basics@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-03-13 15:42:37 -07:00
Alex Waygood
83ccaf2c09
[3.10] Fix duplicated words in the docs ( #102645 )
...
(cherry-picked from commit f6ca71a )
With grep utility found some duplicated words
Co-authored-by: Виталий Дмитриев <vitaldmit@bk.ru>
2023-03-13 14:31:25 +00:00
Miss Islington (bot)
a01ad527e7
gh-101100: Fix Sphinx warnings in turtle module (GH-102340)
...
(cherry picked from commit 78e4e6c3d7 )
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-13 04:11:34 -07:00
Miss Islington (bot)
7276ee0d12
gh-101100: Fix sphinx warnings in zipapp and zipfile modules (GH-102526)
...
(cherry picked from commit 1f557f94c2 )
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-03-08 00:44:34 -08:00
Miss Islington (bot)
4248c24b41
Add gettext support to tools/extensions/c_annotations.py (GH-101989)
...
(cherry picked from commit d959bcd4a0 )
Co-authored-by: Rémi Lapeyre <remi.lapeyre@lenstra.fr>
2023-03-06 13:53:24 -08:00
Miss Islington (bot)
3d88b4e51a
gh-101754: Document that Windows converts keys in os.environ to uppercase (GH-101840)
...
(cherry picked from commit 4e7c0cbf59 )
Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-03-03 02:58:30 -08:00
Alex Waygood
47cc6fac4b
[3.10] Fix typos in documentation and comments (GH-102374) ( #102377 )
...
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 ) also contains two duplicate `to`s, but I wasn't sure if it's ok to touch that file. Looks auto generated. I'm happy to amend the PR if requested. :)
Automerge-Triggered-By: GH:AlexWaygood
Co-authored-by: Michael K <michael-k@users.noreply.github.com>
2023-03-02 16:45:01 +00:00
Hugo van Kemenade
a8f9a82881
[3.10] gh-90744: Fix erroneous doc links in the sys module (GH-101319) ( #102322 )
...
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:50 +02:00
Miss Islington (bot)
ca1cc1484f
gh-102296 Document that inspect.Parameter kinds support ordering (GH-102297)
...
(cherry picked from commit 0db6f44259 )
Co-authored-by: Gouvernathor <44340603+Gouvernathor@users.noreply.github.com>
Automerge-Triggered-By: GH:AlexWaygood
2023-02-27 07:22:07 -08:00
Miss Islington (bot)
cba52ec060
gh-101100: Fix sphinx warnings in types module (GH-102274)
...
(cherry picked from commit 101a12c576 )
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-02-26 23:34:10 -08:00
Miss Islington (bot)
4732f551e2
[3.10] [doc] Improve grammar/fix missing word (GH-102060) (GH-102278)
...
[doc] Improve grammar/fix missing word (GH-102060)
(cherry picked from commit 6daf42b28e )
Co-authored-by: VMan <vayidm@users.noreply.github.com>
2023-02-26 18:58:20 +05:30
Miss Islington (bot)
601c9db455
[3.10] gh-85417: Clarify behaviour on branch cuts in cmath module (GH-102046) ( #102275 )
...
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 )
Co-authored-by: Mark Dickinson <dickinsm@gmail.com>
2023-02-26 11:55:13 +00:00
Miss Islington (bot)
972396143f
gh-102259: Fix re doc issue regarding right square brackets (GH-102264)
...
(cherry picked from commit bcadcde712 )
Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-02-25 18:32:57 -08:00
Shantanu
4667c4dcde
[3.10] GH-99818: improve the documentation for zipfile.Path and Traversable (GH-101589) ( #102267 )
2023-02-25 23:40:55 +00:00
Miss Islington (bot)
d22a2cd422
gh-101100: Fix sphinx warnings in typing module docs (GH-102260)
...
(cherry picked from commit a498de4c0e )
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-02-25 13:54:31 -08:00
Miss Islington (bot)
ac63169792
asyncio docs: Fix dangling hyphen (GH-102227)
...
Currently this gets rendered with a dangling hyphen.
(cherry picked from commit 207e1c5cae )
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-02-25 05:28:16 -08:00
Miss Islington (bot)
9563cf47bc
gh-101100: Fix Sphinx warnings in decimal module (GH-102125)
...
(cherry picked from commit b7c1126447 )
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-02-25 01:51:36 -08:00
Miss Islington (bot)
7d2ad478d1
Fix typo in Py_GetPythonHome signature (GH-102168)
...
(cherry picked from commit 9bba8035bd )
Co-authored-by: Tanner Firl <105078804+TannerFirl@users.noreply.github.com>
2023-02-23 05:37:24 -08:00
Miss Islington (bot)
780dec8a94
Fix syntax error in struct doc example (GH-102160)
...
Missing closing ) reported on Discuss by Chukwudi Nwachukwu.
(cherry picked from commit 8f647477f0 )
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-02-22 16:02:38 -08:00
Miss Islington (bot)
fa592f0e01
GH-101777: queue.rst: use 2 spaces after a period to be consistent. (GH-102143)
...
(cherry picked from commit 96bf24380e )
Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-02-22 13:35:52 -08:00
Miss Islington (bot)
3e9fb1a839
[3.10] gh-102135: Update turtle docs to rename wikipedia demo to rosette (GH-102137) ( #102139 )
...
Co-authored-by: somebody <98094921+UndoneStudios@users.noreply.github.com>
2023-02-22 12:24:18 +02:00
Miss Islington (bot)
444ec74945
gh-100556: Improve clarity of or docs (GH-100589)
...
(cherry picked from commit b40dd71241 )
Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-02-21 02:43:48 -08:00
Miss Islington (bot)
2d9f8d4d38
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 )
Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-02-21 02:31:51 -08:00
Miss Islington (bot)
f193fad4b3
gh-99735: Use required=True in argparse subparsers example (GH-100927)
...
(cherry picked from commit 6aab56f3c2 )
Co-authored-by: Patricio Paez <nospam@pp.com.mx>
2023-02-19 11:35:09 -08:00
Miss Islington (bot)
d104234f51
Fix incorrectly documented attribute in csv docs (GH-101250)
...
(cherry picked from commit 36b670908b )
Co-authored-by: Reza Rastak <rezarastak@users.noreply.github.com>
2023-02-18 17:02:18 -08:00
Brian Skinn
2b1a62c669
[3.10] gh-85747: Active voice & suggested edits, 'running/stopping loop' & 'callbacks' subsections of asyncio-eventloop.rst (gh-100270) ( #102005 )
...
Note: The `timeout` parameter was not added until Python 3.12.
(cherry picked from commit c4de6b1d52 )
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-02-18 15:57:41 -08:00
Miss Islington (bot)
3c1b495cac
gh-100226: Clarify StreamReader.read behavior (GH-101807)
...
(cherry picked from commit 77d95c8373 )
Co-authored-by: Jan Gosmann <jan@hyper-world.de>
2023-02-17 13:24:42 -08:00
Miss Islington (bot)
b6156787fa
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 )
Co-authored-by: Dustin Rodrigues <dust.rod@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-02-17 11:40:20 -08:00
Miss Islington (bot)
f4f5dd5c39
gh-101973: Fix parameter reference for PyModule_FromDefAndSpec (GH-101976)
...
(cherry picked from commit a3bb7fbe7e )
Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2023-02-17 00:51:24 -08:00
Miss Islington (bot)
4d74bb4726
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 )
Co-authored-by: sblondon <stephane.blondon@gmail.com>
2023-02-16 07:22:23 -08:00
Miss Islington (bot)
bc3718eb4b
GH-101898: Fix missing term references for hashable definition (GH-101899)
...
Fix missing term references for hashable definition
(cherry picked from commit 3690688149 )
Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
2023-02-14 02:47:49 -08:00
Miss Islington (bot)
59852bbcc3
Correct trivial grammar in reset_mock docs (GH-101861)
...
(cherry picked from commit a1f08f5f19 )
Co-authored-by: Steve Kowalik <steven@wedontsleep.org>
2023-02-13 01:19:20 -08:00
Miss Islington (bot)
6c0e3dc8ef
[3.10] gh-101390: Fix docs for imporlib.util.LazyLoader.factory to properly call it a class method (GH-101391) (GH-101814)
...
gh-101390: Fix docs for `imporlib.util.LazyLoader.factory` to properly call it a class method (GH-101391)
(cherry picked from commit 17143e2c30 )
Co-authored-by: busywhitespace <busywhitespace@tuta.io>
2023-02-10 16:24:42 -08:00
Miss Islington (bot)
2e7ff1fcf6
Docs: Fix getstatus() -> getcode() typos (GH-101296)
...
(cherry picked from commit 61f2be0866 )
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-02-10 14:26:34 -08:00
Erlend E. Aasland
a565cd5b10
[3.10] Docs: use parameter list for sqlite3.Cursor.execute* (GH-101782) ( #101808 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 2037ebf81b )
2023-02-10 22:21:20 +01:00