Staging
v0.5.1
https://github.com/python/cpython
Revision 6a5d3ff67644af42b1a781be2eacb2e82913441c authored by Gregory P. Smith on 15 May 2020, 21:26:00 UTC, committed by GitHub on 15 May 2020, 21:26:00 UTC
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>
1 parent 938717f
History
Tip revision: 6a5d3ff67644af42b1a781be2eacb2e82913441c authored by Gregory P. Smith on 15 May 2020, 21:26:00 UTC
bpo-40636: Clarify the zip built-in docstring. (GH-20118)
Tip revision: 6a5d3ff
File Mode Size
clinic
Python-ast.c -rw-r--r-- 349.4 KB
README -rw-r--r-- 62 bytes
_warnings.c -rw-r--r-- 38.0 KB
asdl.c -rw-r--r-- 1.4 KB
ast.c -rw-r--r-- 184.1 KB
ast_opt.c -rw-r--r-- 23.4 KB
ast_unparse.c -rw-r--r-- 25.2 KB
bltinmodule.c -rw-r--r-- 83.0 KB
bootstrap_hash.c -rw-r--r-- 17.3 KB
ceval.c -rw-r--r-- 177.1 KB
ceval_gil.h -rw-r--r-- 11.6 KB
codecs.c -rw-r--r-- 44.7 KB
compile.c -rw-r--r-- 169.2 KB
condvar.h -rw-r--r-- 8.4 KB
context.c -rw-r--r-- 30.2 KB
dtoa.c -rw-r--r-- 77.8 KB
dup2.c -rw-r--r-- 759 bytes
dynamic_annotations.c -rw-r--r-- 6.6 KB
dynload_aix.c -rw-r--r-- 5.7 KB
dynload_dl.c -rw-r--r-- 581 bytes
dynload_hpux.c -rw-r--r-- 1.8 KB
dynload_shlib.c -rw-r--r-- 3.4 KB
dynload_stub.c -rw-r--r-- 186 bytes
dynload_win.c -rw-r--r-- 9.7 KB
errors.c -rw-r--r-- 44.6 KB
fileutils.c -rw-r--r-- 54.8 KB
formatter_unicode.c -rw-r--r-- 50.1 KB
frozen.c -rw-r--r-- 1.8 KB
frozenmain.c -rw-r--r-- 3.1 KB
future.c -rw-r--r-- 4.7 KB
getargs.c -rw-r--r-- 86.0 KB
getcompiler.c -rw-r--r-- 538 bytes
getcopyright.c -rw-r--r-- 511 bytes
getopt.c -rw-r--r-- 4.6 KB
getplatform.c -rw-r--r-- 133 bytes
getversion.c -rw-r--r-- 308 bytes
graminit.c -rw-r--r-- 53.1 KB
hamt.c -rw-r--r-- 79.0 KB
hashtable.c -rw-r--r-- 11.2 KB
import.c -rw-r--r-- 68.4 KB
importdl.c -rw-r--r-- 7.3 KB
importdl.h -rw-r--r-- 487 bytes
importlib.h -rw-r--r-- 95.3 KB
importlib_external.h -rw-r--r-- 145.2 KB
importlib_zipimport.h -rw-r--r-- 57.5 KB
initconfig.c -rw-r--r-- 78.9 KB
makeopcodetargets.py -rwxr-xr-x 1.6 KB
marshal.c -rw-r--r-- 47.5 KB
modsupport.c -rw-r--r-- 18.0 KB
mysnprintf.c -rw-r--r-- 3.3 KB
mystrtoul.c -rw-r--r-- 8.1 KB
opcode_targets.h -rw-r--r-- 6.3 KB
pathconfig.c -rw-r--r-- 20.4 KB
peephole.c -rw-r--r-- 19.0 KB
preconfig.c -rw-r--r-- 24.8 KB
pyarena.c -rw-r--r-- 5.5 KB
pyctype.c -rw-r--r-- 7.7 KB
pyfpe.c -rw-r--r-- 345 bytes
pyhash.c -rw-r--r-- 13.3 KB
pylifecycle.c -rw-r--r-- 68.5 KB
pymath.c -rw-r--r-- 1.9 KB
pystate.c -rw-r--r-- 52.6 KB
pystrcmp.c -rw-r--r-- 613 bytes
pystrhex.c -rw-r--r-- 5.2 KB
pystrtod.c -rw-r--r-- 40.1 KB
pythonrun.c -rw-r--r-- 50.0 KB
pytime.c -rw-r--r-- 26.7 KB
strdup.c -rw-r--r-- 251 bytes
structmember.c -rw-r--r-- 8.6 KB
symtable.c -rw-r--r-- 63.0 KB
sysmodule.c -rw-r--r-- 93.4 KB
thread.c -rw-r--r-- 5.3 KB
thread_nt.h -rw-r--r-- 11.9 KB
thread_pthread.h -rw-r--r-- 24.5 KB
traceback.c -rw-r--r-- 24.8 KB
wordcode_helpers.h -rw-r--r-- 1.2 KB

README

back to top