Commit graph

11434 commits

Author SHA1 Message Date
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)
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)
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)
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)
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
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)
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
Barry Warsaw
78c9f39352
[3.10] gh-101021: Document binary parameters as bytes (GH-101024). (#101052)
(cherry picked from commit 49cae39ef0)

Co-authored-by: Bob Kline <bkline@users.noreply.github.com>

Co-authored-by: Bob Kline <bkline@users.noreply.github.com>
2023-01-14 21:31:59 -08:00
Miss Islington (bot)
1981db9de1
gh-100668: Clarify how sqlite3 maps parameters onto placeholders (GH-100960)
(cherry picked from commit 206f05a46b)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-01-14 15:08:32 -08:00
Serhiy Storchaka
87f9b1d53f
[3.10] gh-100160: Remove any deprecation warnings in asyncio.get_event_loop() (GH-100412) (GH-100970)
Some deprecation warnings will reappear (in a slightly different form) in 3.12.

Co-authored-by: Guido van Rossum <guido@python.org>.
(cherry picked from commit 1b2459dc64)
2023-01-13 09:34:55 +02:00
Miss Islington (bot)
e44120a286
GH-100894: Updated the doc for sys.winver to clarify its usual contents (GH-100913)
(cherry picked from commit d9dff4c8b5)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
2023-01-11 16:20:24 -08:00
Hugo van Kemenade
65b01b23bc
[3.10] Fix typos in Doc folder (GH-100880). (#100915)
Co-authored-by: Semen Zhydenko <semen.zhydenko@gmail.com>
2023-01-10 11:42:14 +02:00
Miss Islington (bot)
5c4afdf8bd
bpo-28356: Document os.rename() behavior on Windows for differing volumes (GH-27376)
(cherry picked from commit e098137cd3)

Co-authored-by: Ryan Ozawa <ryan.ozawa21@gmail.com>
2023-01-09 13:52:22 -08:00
Miss Islington (bot)
fa8d396e10
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)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-01-08 01:22:53 -08:00
Miss Islington (bot)
89ea4f92bc
gh-100824: Fix typo in the documentation of unittest.TestLoader.testNamePatterns (GH-100825)
(cherry picked from commit 6d3bc4a795)

Co-authored-by: busywhitespace <busywhitespace@tuta.io>
2023-01-08 00:16:59 -08:00
Alex Waygood
67e52e54bb
[3.10] gh-100673: Removed erroneous note in the get_type_hints docs (#100701) (GH-100826)
Removed erroneous note in the get_type_hints docs

typing.get_type_hints still includes base class type hints.

(cherry picked from commit deaf090699)

Automerge-Triggered-By: GH:AlexWaygood
2023-01-07 12:55:41 -08:00
Miss Islington (bot)
8af15cfc8e
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)

Co-authored-by: Akshit Tyagi <37214399+exitflynn@users.noreply.github.com>
2023-01-06 06:34:12 -08:00
Miss Islington (bot)
f5fa2c1e7f
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)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Co-authored-by: Barney Gale <barney.gale@gmail.com>
2023-01-05 17:56:34 -08:00
Miss Islington (bot)
4bdc57a3d2
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)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Automerge-Triggered-By: GH:hauntsaninja
2023-01-05 15:04:57 -08:00
Miss Islington (bot)
825ad05e1f
GH-100766: Note that locale.LC_MESSAGES is not universal (GH-100768)
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
2023-01-05 03:46:29 +00:00
Miss Islington (bot)
c92c5513b3
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)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-01-01 19:21:50 -08:00
Miss Islington (bot)
8e386deee9
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)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2023-01-01 14:35:46 -08:00
Miss Islington (bot)
e3b303a020
gh-96773 Fix documentation of socket backlog (GH-96778)
(cherry picked from commit 1d1480fefc)

Co-authored-by: Mehrdad Moradizadeh <mhrddmoradii@gmail.com>
2023-01-01 07:16:25 -08:00
Miss Islington (bot)
3ab7b61b41
gh-100616: Document 'attr' parameter for window.vline() in curses module (GH-24961)
(cherry picked from commit f4fcfdf8c5)

Co-authored-by: mathieui <mathieui@users.noreply.github.com>
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-12-30 09:05:40 -08:00
Miss Islington (bot)
2b1cc33db0
[3.10] gh-100583: Improve the pydoc documentation (GH-100590) (#100607)
gh-100583: Improve the `pydoc` documentation  (GH-100590)
(cherry picked from commit 7223d50b97)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
2022-12-29 21:45:13 +05:30
Miss Islington (bot)
4217fafeac
GH-100101: Clarify documentation of zip's strict option (GH-100103)
(cherry picked from commit cf1c098180)

Co-authored-by: JustAnotherArchivist <JustAnotherArchivist@users.noreply.github.com>
2022-12-28 13:32:44 -08:00
Jelle Zijlstra
1ffc67265f
[3.10] gh-99535: Add test for inheritance of annotations and update documentation (GH-99990) (#100509)
(cherry picked from commit f5b7b19bf1)

Co-authored-by: MonadChains <monadchains@gmail.com>
2022-12-26 20:44:53 -08:00
Shantanu
a167365d85
[3.10] gh-92446: Improve argparse choices docs (GH-94627) (#100529)
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)

Co-authored-by: Guy Yagev <yourlefthandman8@gmail.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-26 01:10:48 -06:00
Miss Islington (bot)
ad8d2ef54f
gh-100472: Fix docs claim that compileall parameters could be bytes (GH-100473)
(cherry picked from commit 046cbc2080)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-24 12:29:41 -08:00
Miss Islington (bot)
0dea92409e
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)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-24 12:15:46 -08:00
Miss Islington (bot)
ecfe468a6e
gh-77771: Add enterabs example in sched (GH-92716)
(cherry picked from commit 0f6420640c)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-23 21:30:06 -08:00
Gregory P. Smith
88fe8d701a
[3.10] Correct CVE-2020-10735 documentation (GH-100306). (#100477)
(cherry picked from commit 1cf3d78c92)

Co-authored-by: Jeremy Paige <ucodery@gmail.com>
2022-12-23 18:08:27 -08:00
Miss Islington (bot)
561e15b857
gh-91081: Add note on WeakKeyDictionary behavior when deleting a replaced entry (GH-91499)
(cherry picked from commit c615286e85)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Pieter Eendebak <P.T.eendebak@tudelft.nl>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-12-20 19:34:24 -08:00
Miss Islington (bot)
b3d39c7599
gh-99991: improve docs on str.encode and bytes.decode (GH-100198)
(cherry picked from commit a2bb3b7f9d)

Co-authored-by: Bisola Olasehinde <horlasehinde@gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-12-20 18:11:20 -08:00
Miss Islington (bot)
a757c1b7d3
Clarify that every thread has its own default context in contextvars (GH-99246)
(cherry picked from commit cb60b6131b)

Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
2022-12-20 03:45:48 -08:00