[docs] [issue22702] to improve documentation for join() (str method)

Van Ly report at bugs.python.org
Thu Oct 23 06:21:24 CEST 2014


Van Ly added the comment:

The improvement on the original (doc v.2.7.5) lies in the removal of the repeated 'iterable' in the first sentence, and I have also shortened it to deliver only what is returned by the builtin method which was what I wanted to know without knowing how. I wrote up this reformulation as I would have like to read it. I believe the word "concatenation" is off putting to beginners without a formal background or wanting to acquire that, and there are people like me who prefer plain and simple words. "concatenation" could be used in a footnote to guide readers to more depth if that is something they want to have. The inline usage example serves to confirm what has been described/claimed.

--original: doc v.2.7.5

str.join(iterable)

Return a string which is the concatenation of the strings in the iterable iterable. The separator between elements is the string providing this method.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue22702>
_______________________________________


More information about the docs mailing list