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

2017-05-31 Thread Mariatta Wijaya 

Changes by Mariatta Wijaya :


--
stage: backport needed -> resolved

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2017-05-31 Thread Mariatta Wijaya 

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


--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2017-05-31 Thread Mariatta Wijaya 

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


--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2017-05-31 Thread Mariatta Wijaya 

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


--
nosy: +Mariatta

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2017-05-31 Thread Mariatta Wijaya 

Changes by Mariatta Wijaya :


--
pull_requests: +1976

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2017-05-31 Thread Mariatta Wijaya 

Changes by Mariatta Wijaya :


--
pull_requests: +1975

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2017-05-31 Thread Mariatta Wijaya 

Changes by Mariatta Wijaya :


--
pull_requests: +1974

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2017-05-31 Thread Mariatta Wijaya 

Changes by Mariatta Wijaya :


--
stage: resolved -> backport needed
versions: +Python 3.6, Python 3.7 -Python 3.4

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2017-05-27 Thread Raymond Hettinger 

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 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2017-05-26 Thread Nick Coghlan 

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 to see further changes made?

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2017-05-26 Thread Nick Coghlan 

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


--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2017-04-14 Thread Serhiy Storchaka 

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 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2017-04-09 Thread Nick Coghlan 

Nick Coghlan added the comment:

Noting for the record: Marco Buttu proposed my suggested approach on the PR 
back in early March.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2017-04-09 Thread Nick Coghlan 

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 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2017-02-18 Thread Serhiy Storchaka 

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: +serhiy.storchaka

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2017-02-18 Thread Sanyam Khurana 

Changes by Sanyam Khurana :


--
pull_requests: +120

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2014-10-22 Thread Van Ly 

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 string str to join strings from
iterable. Raises TypeError for non-string found in iterable including
object of bytes.

 # the iterable consists of number
 try:
 print -.join([0, 1, 2, 3])
 except TypeError:
 print A non-string is found in the iterable.
A non-string is found in the iterable.

 # the iterable consists of string
 try:
 print , .join([x, y, z, 0, 1, 2, 3])
 print  - .join([x, y, z, 0, 1, 2, 3])
 print  + .join([x, y, z, 0, 1, 2, 3])
 except TypeError:
 print A non-string is found in the iterable.
x, y, z, 0, 1, 2, 3
x - y - z - 0 - 1 - 2 - 3
x + y + z + 0 + 1 + 2 + 3

--quote--

--
components: Macintosh
files: documentationForJoin.rtf
messages: 229841
nosy: ned.deily, ronaldoussoren, vy0123
priority: normal
severity: normal
status: open
title: to improve documentation for join() (str method)
type: enhancement
versions: Python 2.7, Python 3.3, Python 3.5
Added file: http://bugs.python.org/file36995/documentationForJoin.rtf

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue22702
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2014-10-22 Thread Ned Deily 

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
http://bugs.python.org/issue22702
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2014-10-22 Thread Josh Rosenberg 

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 *strip methods, where it needs to be made clear that 
it's stripping by character, not string matching, or the interaction of 
arguments in str.split).

--
nosy: +josh.r

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue22702
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2014-10-22 Thread Van Ly 

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 rep...@bugs.python.org
http://bugs.python.org/issue22702
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2014-10-22 Thread Raymond Hettinger 

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
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2014-10-22 Thread Raymond Hettinger 

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
http://bugs.python.org/issue22702
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

2014-10-22 Thread Van Ly 

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
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com