]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
bpo-40636: Clarify the zip built-in docstring. (GH-20118)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 15 May 2020 21:43:27 +0000 (14:43 -0700)
committerGitHub <noreply@github.com>
Fri, 15 May 2020 21:43:27 +0000 (14:43 -0700)
commitc3d025a86a60348f19551bd9921304c5db322531
tree5b26b21c1af2b08eca4d902ac3565fbf5a790273
parentfcea08059f46d2d9582bb7ce5b2e905b20b86e8e
bpo-40636: Clarify the zip built-in docstring. (GH-20118)

Clarify the zip built-in docstring.

This puts much simpler text up front along with an example.

As it was, the zip built-in docstring was technically correct.  But too
technical for the reader who shouldn't _need_ to know about `__next__` and
`StopIteration` as most people do not need to understand the internal
implementation details of the iterator protocol in their daily life.

This is a documentation only change, intended to be backported to 3.8; it is
only tangentially related to PEP-618 which might offer new behavior options
in the future.

Wording based a bit more on enumerate per Brandt's suggestion.

This gets rid of the legacy wording paragraph which seems too tied to
implementation details of the iterator protocol which isn't relevant here.

Co-authored-by: Brandt Bucher <brandtbucher@gmail.com>
(cherry picked from commit 6a5d3ff67644af42b1a781be2eacb2e82913441c)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
Lib/test/test_doctest.py
Python/bltinmodule.c