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

Changes by Mariatta Wijaya : -- stage: backport needed -> resolved ___ Python tracker ___

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

Mariatta Wijaya added the comment: New changeset 9139f23464ed0f71cb0e34a535a5b7ddf7fad748 by Mariatta in branch '2.7': bpo-22702: Clarify documentation of str.join & bytes.join (GH-156) (GH-1898) https://github.com/python/cpython/commit/9139f23464ed0f71cb0e34a535a5b7ddf7fad748 --

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

Mariatta Wijaya added the comment: New changeset 9522159bc41f2be0f4aafd0fa182669876aca47f by Mariatta in branch '3.6': bpo-22702: Clarify documentation of str.join & bytes.join (GH-156) (GH-1897) https://github.com/python/cpython/commit/9522159bc41f2be0f4aafd0fa182669876aca47f --

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

Mariatta Wijaya added the comment: New changeset 1721b06a78a4fd7942d9658ac8add6911a1a03e3 by Mariatta in branch '3.5': bpo-22702: Clarify documentation of str.join & bytes.join (GH-156) (GH-1896) https://github.com/python/cpython/commit/1721b06a78a4fd7942d9658ac8add6911a1a03e3 --

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

Changes by Mariatta Wijaya : -- pull_requests: +1976 ___ Python tracker ___ ___

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

Changes by Mariatta Wijaya : -- pull_requests: +1975 ___ Python tracker ___ ___

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

Changes by Mariatta Wijaya : -- pull_requests: +1974 ___ Python tracker ___ ___

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

Changes by Mariatta Wijaya : -- stage: resolved -> backport needed versions: +Python 3.6, Python 3.7 -Python 3.4 ___ Python tracker

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

Raymond Hettinger added the comment: > Do you think that's sufficient to fully resolve the request here, Thanks Nick. That will suffice. -- resolution: -> fixed stage: -> resolved status: open -> closed ___ Python tracker

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

Nick Coghlan added the comment: Raymond, I went ahead and accepted the patch to remove the "iterable iterable" phrasing by only referencing the parameter name and dropping the link to the term definition. Do you think that's sufficient to fully resolve the request here, or would you prefer

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

Nick Coghlan added the comment: New changeset 08e2f355d04d3cbea5751ce1275306ee3f569b32 by Nick Coghlan (Sanyam Khurana) in branch 'master': bpo-22702: Clarify documentation of str.join & bytes.join (GH-156) https://github.com/python/cpython/commit/08e2f355d04d3cbea5751ce1275306ee3f569b32

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

Serhiy Storchaka added the comment: A reference to the iterable term was added in issue7116 when str.join() started accepting arbitrary iterables rather than just sequences. -- ___ Python tracker

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

Nick Coghlan added the comment: Noting for the record: Marco Buttu proposed my suggested approach on the PR back in early March. -- ___ Python tracker

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

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

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

Serhiy Storchaka added the comment: Current documentation looks good to me and not needing changes (except fixing the doubled "iterable"). Proposed change looks incorrect to me. No parameter named "str" is provided in this method. See also the docstring of str.join. -- nosy:

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

Changes by Sanyam Khurana : -- pull_requests: +120 ___ Python tracker ___ ___

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

New submission from Van Ly: This issue should go in the Documentation component but that is not an option in the issue tracker. Suggestion to improve documentation for join() (str method). Applies to versions 2.7.5, 3.3.6, 3.5.0a0. --quote str.join(iterable) Returns a string. Uses the

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

Changes by Ned Deily n...@acm.org: -- assignee: - docs@python components: +Documentation -Macintosh nosy: +docs@python -ned.deily, ronaldoussoren versions: +Python 3.4 -Python 3.3 ___ Python tracker rep...@bugs.python.org

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

Josh Rosenberg added the comment: Seems awfully verbose relative to the standards of the other built-in methods. Can you explain what improvements you feel this provides? str.join isn't a particularly complex method, relative to the other str methods that have inline usage examples (e.g. the

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

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

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

Changes by Raymond Hettinger raymond.hettin...@gmail.com: -- assignee: docs@python - rhettinger nosy: +rhettinger ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue22702 ___

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

Raymond Hettinger added the comment: At least the iterable iterable should be fixed. However, as Josh said, the proposed wording is verbose. Aim for the smallest number of words that gets the job done. -- ___ Python tracker rep...@bugs.python.org

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

Van Ly added the comment: Aim for the fewest syllables in the words without losing meaning or good taste. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue22702 ___