Commit graph

11947 commits

Author SHA1 Message Date
Irit Katriel
c796d34b2a
[3.11] gh-101454: fix documentation for END_ASYNC_FOR (#101455) (#101493)
gh-101454: fix documentation for END_ASYNC_FOR (#101455)

(cherry picked from commit 62251c3da0)
2023-02-01 14:30:48 +00:00
Miss Islington (bot)
85cc5d0e5d
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:19 -08:00
Miss Islington (bot)
a79dd88973
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:48 -08:00
Miss Islington (bot)
6a94f4c973
Fixes typo in asyncio.TaskGroup context manager code example (GH-101449)
(cherry picked from commit ef09bf63d2)

Co-authored-by: Ben <22038077+bcla22@users.noreply.github.com>
2023-01-30 21:46:35 -08:00
Miss Islington (bot)
6ec9f2d5b8
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:26 -08:00
Miss Islington (bot)
3bcb630e07
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:29 -08:00
Miss Islington (bot)
88a1e6db0f
[3.11] [doc] Add a section on logging handler configuration order. (GH-101380) (GH-101382)
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2023-01-27 19:12:18 +00:00
Miss Islington (bot)
1016909a6d
[3.11] [doc] Add some notices to logging configuration documentation. (GH-101373) (GH-101376)
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2023-01-27 17:45:59 +00:00
Miss Islington (bot)
4cf4169350
Added asyncio REPL example to docs. (GH-101243)
(cherry picked from commit 5d868efde9)

Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es>
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2023-01-23 03:39:01 -08:00
Miss Islington (bot)
69d12d868e
[3.11] GH-101097: Switch from standard interval notation to greater or less than signs for random.random()'s documentation (GH-101119) (GH-101246)
(cherry picked from commit 8bcd4a6ec7)

Co-authored-by: Andrew Hong <andrewhong@myyahoo.com>

Automerge-Triggered-By: GH:rhettinger
2023-01-22 13:45:55 -08:00
Miss Islington (bot)
db0eeb381e
[3.11] gh-86610: Use attribute directive in docs for pathlib.PurePath (GH-101114) (#101205)
(cherry picked from commit 01093b8203)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
2023-01-20 23:28:21 +01:00
Miss Islington (bot)
efc89f3454
[3.11] GH-101111: Disambigaute origin of const for store_const and append_const (GH-101121) (#101203)
(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:04 +01:00
Miss Islington (bot)
1798df2b40
[3.11] Fix minor typos in SSL documentation (GH-101158) (#101201)
(cherry picked from commit 73497690b5)

Co-authored-by: Simon Robinson <simon@robinson.ac>
2023-01-20 23:18:25 +01:00
Miss Islington (bot)
0dc35e4bbb
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:12:26 -08:00
Miss Islington (bot)
e039d53dae
[3.11] gh-101100: [Enum] Fix sphinx warnings in docs (GH-101122) (#101173)
(cherry picked from commit 9e025d305f)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-01-20 23:07:23 +01:00
Gregory P. Smith
efe3a389ca
[3.11] gh-101144: Allow zipfile.Path .open & .read_text encoding to be positional (#101179)
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)

Co-authored-by: Gregory P. Smith <greg@krypto.org> [Google]
2023-01-20 00:06:18 -08:00
Miss Islington (bot)
1998ea69c7
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:47 -08:00
Miss Islington (bot)
db65a326a4
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:43:44 -08:00
Miss Islington (bot)
5e52778b1a
Fix typo in ReprEnum documentation (GH-101079)
(cherry picked from commit c5660ae96f)

Co-authored-by: Viicos <65306057+Viicos@users.noreply.github.com>
2023-01-17 02:59:35 -08:00
Miss Islington (bot)
6d98282ed4
[3.11] Sync-up parameter name in equivalent code snippet of enumerate (GH-101029) (#101030)
Sync-up parameter name in equivalent code snippet of `enumerate` (GH-101029)
(cherry picked from commit ef633e5000)

Co-authored-by: JustAnotherArchivist <JustAnotherArchivist@users.noreply.github.com>
2023-01-15 12:16:06 +05:30
Miss Islington (bot)
c7aa39286b
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:04:53 -08:00
Miss Islington (bot)
39c1f68fff
gh-101021: Document binary parameters as bytes (GH-101024)
(cherry picked from commit 49cae39ef0)

Co-authored-by: Bob Kline <bkline@users.noreply.github.com>
2023-01-14 12:22:08 -08:00
Raymond Hettinger
ba88628808
[3.11] Add recipes to showcase tee(), zip*, batched, starmap, and product. (GH-101028) 2023-01-13 22:32:32 -06:00
Serhiy Storchaka
2834fdc689
[3.11] gh-100160: Tweak the documentation for the default asyncio policy (GH-100969) 2023-01-13 10:15:23 +02:00
Miss Islington (bot)
75717645bc
Fix typo in enum module documentation (GH-100992)
(cherry picked from commit 2161bbf243)

Co-authored-by: Noam Cohen <noam@noam.me>
2023-01-12 07:51:11 -08:00
Miss Islington (bot)
e8097d49f6
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:21:07 -08:00
Serhiy Storchaka
1b2459dc64
[3.11] gh-100160: Remove any deprecation warnings in asyncio.get_event_loop() (#100412)
Some deprecation warnings will reappear (in a slightly different form) in 3.12.

Co-authored-by: Guido van Rossum <guido@python.org>
2023-01-10 12:20:09 -08:00
Hugo van Kemenade
1e74a12bde
[3.11] Fix typos in Doc folder (GH-100880). (#100914)
Co-authored-by: Semen Zhydenko <semen.zhydenko@gmail.com>
2023-01-10 11:42:03 +02:00
Miss Islington (bot)
4e096ec647
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:43 -08:00
Miss Islington (bot)
87076d880c
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:44 -08:00
Miss Islington (bot)
caed845fb5
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:49 -08:00
Raymond Hettinger
4b4e6da7b5
[3.11] Future-proof recipe by renaming dotproduct() to sumprod() (GH-100828) 2023-01-07 15:16:38 -06:00
Miss Islington (bot)
a3e2407f5c
gh-100673: Removed erroneous note in the get_type_hints docs (GH-100701)
Removed erroneous note in the get_type_hints docs

typing.get_type_hints still includes base class type hints.
(cherry picked from commit deaf090699)

Co-authored-by: FrozenBob <30644137+FrozenBob@users.noreply.github.com>
2023-01-07 09:38:32 -08:00
Miss Islington (bot)
72263f2a20
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:30 -08:00
Miss Islington (bot)
d6b8413e94
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:59:27 -08:00
Miss Islington (bot)
75861006d8
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:39 -08:00
Miss Islington (bot)
a34f0bdcf6
GH-100766: Note that locale.LC_MESSAGES is not universal (GH-100767)
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
2023-01-05 03:46:13 +00:00
Miss Islington (bot)
7e9b2b0aa7
[Enum] docs: replace 'last value' by 'highest value' for Flag auto (GH-100709)
(cherry picked from commit 64ed609c53)

Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
2023-01-03 14:27:38 -08:00
Miss Islington (bot)
af136e9877
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:58 -08:00
Miss Islington (bot)
e7a2659b4c
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:39 -08:00
Miss Islington (bot)
c7dcfdaef6
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:13:50 -08:00
Miss Islington (bot)
7ed7127876
gh-100546: Remove incorrect positional-only marker from eval (GH-100547)
All the arguments are positional-only.

The current status after GH-99476 seems to be to not use positional-only
markers in documentation, hence I've simply removed it.
(cherry picked from commit 71159a8e07)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-31 17:06:31 -08:00
Miss Islington (bot)
18006309ea
[3.11] Improve comments in itertools uniquification recipes (GH-100631) (GH-100632) 2022-12-30 22:23:39 -06:00
Miss Islington (bot)
297465a4db
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:49 -08:00
Miss Islington (bot)
e180dff4c7
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 07:24:11 -08:00
Miss Islington (bot)
ac31120de7
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:19 -08:00
Miss Islington (bot)
9120450b25
Restore early-out to factor(). Strengthen tests. (GH-100591)
(cherry picked from commit c4c5790120)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2022-12-28 12:37:58 -08:00
Miss Islington (bot)
95fa61cbce
Improve factor() recipe and fix its tests (GH-100576)
(cherry picked from commit 2d52406835)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2022-12-28 03:22:11 -08:00
Shantanu
2cb4b13af6
[3.11] gh-92446: Improve argparse choices docs (GH-94627) (#100528)
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:09:06 -06:00
Miss Islington (bot)
44b664e057
gh-99535: Add test for inheritance of annotations and update documentation (GH-99990)
(cherry picked from commit f5b7b19bf1)

Co-authored-by: MonadChains <monadchains@gmail.com>
2022-12-24 12:31:10 -08:00