From 9139f23464ed0f71cb0e34a535a5b7ddf7fad748 Mon Sep 17 00:00:00 2001 From: Mariatta Date: Wed, 31 May 2017 19:49:30 -0700 Subject: [PATCH] bpo-22702: Clarify documentation of str.join & bytes.join (GH-156) (GH-1898) 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 bd3a17942f..f0ecd96d93 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]) -- 2.50.1