Commit graph

25160 commits

Author SHA1 Message Date
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
Miss Islington (bot)
9889de3fa7
Apply suggestions from code review 2023-02-08 15:45:17 -08:00
Miss Islington (bot)
8bc41112a0
[3.10] gh-47937: Note that Popen attributes are read-only (GH-93070) (#101683)
* 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)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Gregory P. Smith <greg@krypto.org>
2023-02-08 11:04:15 +01:00
Oleg Iarygin
7d727518be
[3.10] gh-97725: Fix documentation for the default file of asyncio.Task.print_stack (#101652) (#101654)
(cherry picked from commit f87f6e2396)
2023-02-08 11:02:54 +01:00
Miss Islington (bot)
25196d6fb2
GH-101616: Mention the Docs Discourse forum in the "reporting docs issues" (GH-101617)
Fixes https://github.com/python/cpython/issues/101616
(cherry picked from commit 949c58f945)

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
2023-02-06 14:10:23 -08:00
Miss Islington (bot)
dbdbc796d2
GH-56426: Add cross-reference to the documentation for faulthandler, traceback, and pdb. (GH-101157)
(cherry picked from commit cef9de62b8)

Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-02-03 19:57:34 -08:00
Miss Islington (bot)
42b14044aa
docs: replace PyPI description with link (GH-101506)
(cherry picked from commit 45d014e03b)

Co-authored-by: François Magimel <magimel.francois@gmail.com>
2023-02-02 23:29:56 -08:00
Miss Islington (bot)
4c732bc425
gh-100920: Update documentation for asyncio.StreamWriter.wait_closed (GH-101514)
(cherry picked from commit 5c39daf50b)

Co-authored-by: Viet Than <thanhoangviet@gmail.com>
2023-02-02 23:26:05 -08:00
Miss Islington (bot)
c3dd95a669
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)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-02-02 16:11:31 -08:00
Miss Islington (bot)
f8abe755e8
Docs: improve accuracy of sqlite3 check_same_thread parameter (GH-101351)
(cherry picked from commit ee21110086)

Co-authored-by: Marcos Pereira <3464445+marcospgp@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-02-01 16:00:21 -08:00
Miss Islington (bot)
b8bb139e22
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)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-01-31 21:48:51 -08:00
Miss Islington (bot)
6b2ed1c299
gh-101440: fix json snippet error in logging-cookbook.rst (GH-101439)
(cherry picked from commit 20c11f2e60)

Co-authored-by: Peter Jiping Xie <peter.jp.xie@gmail.com>
2023-01-31 07:38:28 -08:00
Miss Islington (bot)
ca1184898a
[3.10] gh-99276 - Updated Doc/faq/general.rst (GH-101396) (#101462)
Co-authored-by: Raj <51259329+workingpayload@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-01-31 17:28:07 +02:00
Miss Islington (bot)
71db9c9ea5
Add JOBS parameter to docs Makefile (GH-101395)
(cherry picked from commit 1a62ae84c6)

Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
2023-01-31 05:36:54 -08:00
Miss Islington (bot)
f36c2729d6
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)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-01-30 21:46:43 -08:00
Miss Islington (bot)
626e2cc123
gh-101422: (docs) TarFile default errorlevel argument is 1, not 0 (GH-101424)
(cherry picked from commit ea232716d3)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-01-30 10:10:01 -08:00
Miss Islington (bot)
efcab4dd63
gh-98240: Updated Path.rename docs, when it is atomic (GH-98245)
(cherry picked from commit 0023f51deb)

Co-authored-by: Mateusz <mateka@users.noreply.github.com>
2023-01-29 17:52:46 -08:00
Miss Islington (bot)
6aabbe2b15
Fix trivial typo in shebang example (GH-101385)
The example was showing the current version, but should be pinned to 3.7 to match the example command.
(cherry picked from commit 666c0840dc)

Co-authored-by: socal-nerdtastic <37753609+socal-nerdtastic@users.noreply.github.com>
2023-01-29 13:14:18 -08:00
Miss Islington (bot)
95f75ca6d8
[3.10] [doc] Add a section on logging handler configuration order. (GH-101380) (GH-101381)
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2023-01-27 19:12:00 +00:00
Miss Islington (bot)
0814a809d7
[3.10] [doc] Add some notices to logging configuration documentation. (GH-101373) (GH-101375)
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2023-01-27 17:45:22 +00:00
Miss Islington (bot)
a259efc63f
[docs] Mention how to get/set a bigint PyLong via the C API (GH-101270)
We don't need direct C APIs to get at a bigint representation of PyLong but we
do want the few people who need to understand how.

Additional Author:  CAM-Gerlach
(cherry picked from commit e244401ce5)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2023-01-23 21:30:29 -08:00
Kumar Aditya
e24c73e71e
[3.10] Added asyncio REPL example to docs. (GH-101243) (#101257)
(cherry picked from commit 5d868efde9)

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es>
2023-01-23 17:22:38 +05:30
Miss Islington (bot)
6919c36541
[3.10] gh-86610: Use attribute directive in docs for pathlib.PurePath (GH-101114) (#101206)
(cherry picked from commit 01093b8203)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
2023-01-20 23:28:35 +01:00
Miss Islington (bot)
f1313ab979
[3.10] GH-101111: Disambigaute origin of const for store_const and append_const (GH-101121) (#101204)
(cherry picked from commit 9a155138c5)

While the documentation for `optparse` mentioned that both `store_const` and
`append_const` store a constant value, it was not clear where this value was
coming from.

A link to `Option.const` makes this explicit.

Co-authored-by: Jürgen Gmach <juergen.gmach@googlemail.com>
2023-01-20 23:22:21 +01:00
Miss Islington (bot)
8fd481e62e
[3.10] Fix minor typos in SSL documentation (GH-101158) (#101202)
(cherry picked from commit 73497690b5)

Co-authored-by: Simon Robinson <simon@robinson.ac>
2023-01-20 23:17:58 +01:00
Miss Islington (bot)
23bb5f35f5
gh-91485: Avoid unnecessary use of non-Python syntax in io docs (GH-101177)
(cherry picked from commit 783d1bc51b)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-01-20 14:16:10 -08:00
Miss Islington (bot)
2fe0404deb
[3.10] Provided better example for logging cookbook (GH-101164) (GH-101183)
Co-authored-by: Vladimir Malinovskii <galqiwi@galqiwi.ru>
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2023-01-20 17:42:40 +00:00
Miss Islington (bot)
b2a662fc6b
[3.10] gh-101144: Allow zipfile.Path .open & .read_text encoding to be positional (GH-101179) (GH-101182)
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)
(cherry picked from commit efe3a389ca)

Co-authored-by: Gregory P. Smith <greg@krypto.org> [Google]

Automerge-Triggered-By: GH:gpshead
2023-01-20 00:31:15 -08:00
Miss Islington (bot)
10c6130124
gh-101041: Fix a misspelled name of utctimetuple in a doc warning (GH-101042)
(cherry picked from commit 8e9d08b062)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2023-01-19 21:06:04 -08:00
Miss Islington (bot)
2c1eeb508c
Docs: improve sqlite3 placeholders example (GH-101092)
(cherry picked from commit b84be8d9c0)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2023-01-18 01:42:55 -08:00