[docs] [issue22702] to improve documentation for join() (str method)
Nick Coghlan
report at bugs.python.org
Sun Apr 9 05:55:54 EDT 2017
Nick Coghlan added the comment:
Raymond, in the review comments on https://github.com/python/cpython/pull/156 Xiang noted that the current apparently duplicated iterable isn't entirely redundant:
- the first reference is to the term "iterable"
- the second reference is to the parameter name "*iterable*"
"Return a string which is the concatenation of the strings in the :term:`iterable` *iterable*."
So if we're going to drop one of them, it should probably be the link to the term, rather than the parameter name:
"Return a string which is the concatenation of the strings in *iterable*."
Does that sound reasonable to you?
----------
nosy: +ncoghlan, xiang.zhang
_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue22702>
_______________________________________
More information about the docs
mailing list