cpython/Python
Gregory P. Smith 6a5d3ff676
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>
2020-05-15 14:26:00 -07:00
..
clinic
_warnings.c
asdl.c
ast.c bpo-40334: Correctly identify invalid target in assignment errors (GH-20076) 2020-05-15 02:04:52 +01:00
ast_opt.c
ast_unparse.c
bltinmodule.c bpo-40636: Clarify the zip built-in docstring. (GH-20118) 2020-05-15 14:26:00 -07:00
bootstrap_hash.c
ceval.c Fix typo in code comment in main_loop label. (GH-20068) 2020-05-14 19:25:45 -07:00
ceval_gil.h
codecs.c
compile.c
condvar.h
context.c
dtoa.c
dup2.c
dynamic_annotations.c
dynload_aix.c
dynload_dl.c
dynload_hpux.c
dynload_shlib.c
dynload_stub.c
dynload_win.c
errors.c
fileutils.c
formatter_unicode.c
frozen.c
frozenmain.c
future.c
getargs.c
getcompiler.c
getcopyright.c
getopt.c
getplatform.c
getversion.c
graminit.c
hamt.c
hashtable.c bpo-40602: _Py_hashtable_set() reports rehash failure (GH-20077) 2020-05-14 22:44:32 +02:00
import.c
importdl.c
importdl.h
importlib.h
importlib_external.h
importlib_zipimport.h
initconfig.c
makeopcodetargets.py
marshal.c bpo-40602: Write unit tests for _Py_hashtable_t (GH-20091) 2020-05-14 21:55:47 +02:00
modsupport.c
mysnprintf.c
mystrtoul.c
opcode_targets.h
pathconfig.c
peephole.c
preconfig.c
pyarena.c
pyctype.c
pyfpe.c
pyhash.c bpo-40602: Add _Py_HashPointerRaw() function (GH-20056) 2020-05-12 18:46:20 +02:00
pylifecycle.c
pymath.c
pystate.c
pystrcmp.c
pystrhex.c
pystrtod.c
Python-ast.c
pythonrun.c bpo-40612: Fix SyntaxError edge cases in traceback formatting (GH-20072) 2020-05-14 19:22:48 -07:00
pytime.c
README
strdup.c
structmember.c
symtable.c
sysmodule.c
thread.c
thread_nt.h
thread_pthread.h
traceback.c
wordcode_helpers.h

Miscellaneous source files for the main Python shared library