Skip to content

Commit

Permalink
[2.7] bpo-22702: Clarify documentation of str.join & bytes.join (pyth…
Browse files Browse the repository at this point in the history
…onGH-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 08e2f35)
  • Loading branch information
CuriousLearner authored and Mariatta committed Jun 1, 2017
1 parent 32e220f commit 8b81dd4
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions Doc/library/stdtypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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])
Expand Down

0 comments on commit 8b81dd4

Please sign in to comment.