From 8b81dd46783c6d1e9746d91e3742ccc3a4f477a3 Mon Sep 17 00:00:00 2001 From: Sanyam Khurana Date: Sat, 27 May 2017 11:14:41 +0530 Subject: [PATCH] [2.7] bpo-22702: Clarify documentation of str.join & bytes.join (GH-156) The "iterable iterable" phrasing created confusion between the term reference and the parameter name. This simplifies the phrasing to just use the parameter name without linking directly to the term definition.. (cherry picked from commit 08e2f355d04d3cbea5751ce1275306ee3f569b32) --- Doc/library/stdtypes.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst index bd3a17942fa347..f0ecd96d939de3 100644 --- a/Doc/library/stdtypes.rst +++ b/Doc/library/stdtypes.rst @@ -1068,9 +1068,10 @@ string functions based on regular expressions. .. method:: str.join(iterable) - Return a string which is the concatenation of the strings in the - :term:`iterable` *iterable*. The separator between elements is the string - providing this method. + Return a string which is the concatenation of the strings in *iterable*. + A :exc:`TypeError` will be raised if there are any non-string values in + *iterable*, including :class:`bytes` objects. The separator between + elements is the string providing this method. .. method:: str.ljust(width[, fillchar])