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 bpo-40421: Add PyFrame_GetBack() function (GH-19765) 2020-04-29 03:28:46 +02:00
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 bpo-40334: PEP 617 implementation: New PEG parser for CPython (GH-19503) 2020-04-22 23:29:27 +01:00
ast_unparse.c Add spaces around the ":=" operator in ast_unparse.c (GH-19568) 2020-04-18 17:17:19 +01:00
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 bpo-40513: Per-interpreter GIL (GH-19943) 2020-05-05 20:27:47 +02:00
codecs.c bpo-40268: Remove a few pycore_pystate.h includes (GH-19510) 2020-04-14 17:52:15 +02:00
compile.c bpo-40334: Don't downcast from Py_ssize_t to int (GH-19671) 2020-04-23 03:43:08 +01:00
condvar.h
context.c bpo-40428: Remove PyTuple_ClearFreeList() function (GH-19769) 2020-04-29 02:29:20 +02:00
dtoa.c
dup2.c
dynamic_annotations.c
dynload_aix.c
dynload_dl.c
dynload_hpux.c bpo-40268: Add _PyInterpreterState_GetConfig() (GH-19492) 2020-04-13 03:04:28 +02:00
dynload_shlib.c bpo-40268: Rename _PyInterpreterState_GET_UNSAFE() (GH-19509) 2020-04-14 15:14:01 +02:00
dynload_stub.c
dynload_win.c
errors.c bpo-29587: _PyErr_ChainExceptions() checks exception (GH-19902) 2020-05-05 17:07:41 +02:00
fileutils.c bpo-40268: Remove unused osdefs.h includes (GH-19532) 2020-04-15 03:24:57 +02:00
formatter_unicode.c bpo-39943: Add the const qualifier to pointers on non-mutable PyUnicode data. (GH-19345) 2020-04-11 10:48:40 +03:00
frozen.c
frozenmain.c bpo-40268: Remove a few pycore_pystate.h includes (GH-19510) 2020-04-14 17:52:15 +02:00
future.c
getargs.c bpo-39943: Add the const qualifier to pointers on non-mutable PyUnicode data. (GH-19345) 2020-04-11 10:48:40 +03:00
getcompiler.c
getcopyright.c
getopt.c bpo-40527: Fix command line argument parsing (GH-19955) 2020-05-06 22:22:17 +09:00
getplatform.c
getversion.c
graminit.c
hamt.c bpo-40268: Remove unused structmember.h includes (GH-19530) 2020-04-15 02:35:41 +02:00
hashtable.c bpo-40602: _Py_hashtable_set() reports rehash failure (GH-20077) 2020-05-14 22:44:32 +02:00
import.c bpo-40417: Fix deprecation warning in PyImport_ReloadModule (GH-19750) 2020-05-01 16:28:06 -07:00
importdl.c
importdl.h
importlib.h bpo-40334: PEP 617 implementation: New PEG parser for CPython (GH-19503) 2020-04-22 23:29:27 +01:00
importlib_external.h bpo-40334: PEP 617 implementation: New PEG parser for CPython (GH-19503) 2020-04-22 23:29:27 +01:00
importlib_zipimport.h
initconfig.c bpo-40453: Add PyConfig._isolated_subinterpreter (GH-19820) 2020-05-01 11:33:44 +02:00
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 bpo-40170: Add _PyIndex_Check() internal function (GH-19426) 2020-04-08 02:01:56 +02:00
mysnprintf.c
mystrtoul.c
opcode_targets.h
pathconfig.c bpo-40268: Remove unused osdefs.h includes (GH-19532) 2020-04-15 03:24:57 +02:00
peephole.c
preconfig.c bpo-40514: Add --with-experimental-isolated-subinterpreters (GH-19926) 2020-05-05 16:41:11 +02:00
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 bpo-40513: Per-interpreter GIL (GH-19943) 2020-05-05 20:27:47 +02:00
pymath.c
pystate.c bpo-40522: _PyThreadState_Swap() sets autoTSSkey (GH-19939) 2020-05-05 19:56:48 +02:00
pystrcmp.c
pystrhex.c bpo-40313: speed up bytes.hex() (GH-19594) 2020-04-20 17:17:52 -07:00
pystrtod.c
Python-ast.c bpo-40528: Improve and clear several aspects of the ASDL definition code for the AST (GH-19952) 2020-05-06 15:29:32 +01:00
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 bpo-40268: Remove unused structmember.h includes (GH-19530) 2020-04-15 02:35:41 +02:00
symtable.c bpo-40268: Remove unused structmember.h includes (GH-19530) 2020-04-15 02:35:41 +02:00
sysmodule.c bpo-40421: Add PyFrame_GetBack() function (GH-19765) 2020-04-29 03:28:46 +02:00
thread.c bpo-40268: Remove explicit pythread.h includes (#19529) 2020-04-15 02:04:42 +02:00
thread_nt.h bpo-40268: Rename _PyInterpreterState_GET_UNSAFE() (GH-19509) 2020-04-14 15:14:01 +02:00
thread_pthread.h bpo-40268: Rename _PyInterpreterState_GET_UNSAFE() (GH-19509) 2020-04-14 15:14:01 +02:00
traceback.c bpo-40421: Add PyFrame_GetBack() function (GH-19765) 2020-04-29 03:28:46 +02:00
wordcode_helpers.h

Miscellaneous source files for the main Python shared library