diff options
| author | Sanyam Khurana <CuriousLearner@users.noreply.github.com> | 2017-05-27 05:44:41 (GMT) |
|---|---|---|
| committer | Nick Coghlan <ncoghlan@gmail.com> | 2017-05-27 05:44:41 (GMT) |
| commit | 08e2f355d04d3cbea5751ce1275306ee3f569b32 (patch) | |
| tree | 1c7f4b9bae35c64f70e18b3de15b0232f394604e | |
| parent | 2b44e302ec3079363c4d5c875677945953705c58 (diff) | |
| download | cpython-08e2f355d04d3cbea5751ce1275306ee3f569b32.zip cpython-08e2f355d04d3cbea5751ce1275306ee3f569b32.tar.gz cpython-08e2f355d04d3cbea5751ce1275306ee3f569b32.tar.bz2 | |
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.
| -rw-r--r-- | Doc/library/stdtypes.rst | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst index 8f0a080..66a7d92 100644 --- a/Doc/library/stdtypes.rst +++ b/Doc/library/stdtypes.rst @@ -1719,10 +1719,10 @@ expression support in the :mod:`re` module). .. method:: str.join(iterable) - Return a string which is the concatenation of the strings in the - :term:`iterable` *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. + 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]) @@ -2554,11 +2554,11 @@ arbitrary binary data. bytearray.join(iterable) Return a bytes or bytearray object which is the concatenation of the - binary data sequences in the :term:`iterable` *iterable*. A - :exc:`TypeError` will be raised if there are any values in *iterable* - that are not :term:`bytes-like objects <bytes-like object>`, including - :class:`str` objects. The separator between elements is the contents - of the bytes or bytearray object providing this method. + binary data sequences in *iterable*. A :exc:`TypeError` will be raised + if there are any values in *iterable* that are not :term:`bytes-like + objects <bytes-like object>`, including :class:`str` objects. The + separator between elements is the contents of the bytes or + bytearray object providing this method. .. staticmethod:: bytes.maketrans(from, to) |