]> granicus.if.org Git - python/commitdiff
bpo-22702: Clarify documentation of str.join & bytes.join (GH-156) (GH-1898)
authorMariatta <Mariatta@users.noreply.github.com>
Thu, 1 Jun 2017 02:49:30 +0000 (19:49 -0700)
committerGitHub <noreply@github.com>
Thu, 1 Jun 2017 02:49:30 +0000 (19:49 -0700)
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

index bd3a17942fa3479ed9502118ed64134aa0d8f6cc..f0ecd96d939de3bb3b9542f806d3a691c25ea7fb 100644 (file)
@@ -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])