[issue22725] improve documentation for enumerate() (built-in function)

2014-10-27 Thread Van Ly
Van Ly added the comment: While next() is rarely used directly on iterators, as you say, it may help to remind the experienced reader of the mechanical characteristic in essence which a new reader on first approach uses to construct a mental model

[issue22741] suggestion for improving wording on len(s) (built-in function)

2014-10-27 Thread Van Ly
New submission from Van Ly: -- suggest the following because -- the parenthetical parts interrupt the reading too often len(s) Returns a length count, the number of objects in argument s which may be a sequence, or mapping: a string, list or tuple, or a dictionary. -- assignee: docs

[issue22738] improve sys.argv, 'python -h' documentation

2014-10-27 Thread Van Ly
Van Ly added the comment: The font choice is a matter of style beyond me. I commented on it as I saw it. The second rendering looks in Capital relative to the first rendering. The problem wasn't there in v.2.7.5. In saying that, perhaps the information would be picked up by someone

[issue22741] suggestion for improving wording on len(s) (built-in function)

2014-10-27 Thread Van Ly
Van Ly added the comment: (Well that is a stick in the mud and slap in the face attitude to different ways of describing what is there.) You have the documentation for len(s) perfect, __for_everyone__. -- ___ Python tracker rep...@bugs.python.org

[issue22738] improve 'python -h' documentation for '-c'

2014-10-27 Thread Van Ly
Van Ly added the comment: I don't know what you mean by optimal English. As is, the English is of the native English speaker's comfy couch guides speaking to guides kind rather than guides speaking to audience wanting to be guided by. The suggestion I offered is imperfect and can be improved

[issue22738] improve 'python -h' documentation for '-c'

2014-10-27 Thread Van Ly
Van Ly added the comment: -c str : interpret str as a program (terminates option list) +1 (feed is shorter) -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue22738

[issue22736] tutorial links at top, book recommendations at bottom of module documentation

2014-10-26 Thread Van Ly
New submission from Van Ly: IMO the box highlight at the top of module documentation, for example, re module (library/re.html#module-re), ought to place book recommendations at the very bottom in a section called 'Further Readings'. Why? Because being at the top of the documentation should

[issue22725] improve documentation for enumerate() (built-in function)

2014-10-26 Thread Van Ly
Van Ly added the comment: Reference by the guide to next() should stay for the same reason in re.compile() a regular expression object is returned and the two methods are mentioned, match() and search(). They are useful to know in that context in as much as next() is useful to know here. IMO

[issue22738] improve sys.argv, 'python -h' documentation

2014-10-26 Thread Van Ly
New submission from Van Ly: I was looking at sys.argv from the reference guide. The font mix and change from v.2.7.5 to v.3.5.0a0 for sentence two of sys.argv (library/sys.html#module-sys) has made the second rendering of -c look capital when in fact it isn't. --quote: from v.3.5.0a0

[issue22725] improve documentation for enumerate() (built-in function)

2014-10-25 Thread Van Ly
Van Ly added the comment: I don't want to argue. Ask a 12-year old and their English teacher, Does the second sentence qualify as gobbledygook even if it is technically correct and complete and not verbose? To be constructive and take on what has been said, an iteration on improving

[issue22725] improve documentation for enumerate() (built-in function)

2014-10-25 Thread Van Ly
Van Ly added the comment: Understood. I felt the problem was self evident with sequence must be a sequence. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue22725

[issue22725] improve documentation for enumerate() (built-in function)

2014-10-25 Thread Van Ly
Van Ly added the comment: sequence must be a sequence The subtle minutiae of aficionados necessary to interpret the meaning of those two words in their distinct relation is opaque to a new comer and doesn’t serve the widest possible audience usefully to get the job done quick. The second

[issue22725] improve documentation for enumerate() (built-in function)

2014-10-25 Thread Van Ly
Van Ly added the comment: The first mention of iterator should link to 'glossary.html#term-iterator'. There is a builtin iter() function. This may cause confusion in earlier suggested inline sample code. -- Use the following inline sample code -- in place of 'iter = enumerate(led)'to avoid

[issue22725] improve documentation for enumerate() (built-in function)

2014-10-24 Thread Van Ly
New submission from Van Ly: The existing documentation is confusing. — improve wording as follows enumerate(sequence, start=0) Returns pairings of index into sequence[link to glossary.html#term-sequence] with the object at that index in the sequence. — wording as found in v.2.7.5

[issue22714] target of 'import statement' entry in general index for 'i' is wrong

2014-10-23 Thread Van Ly
New submission from Van Ly: The target points to within '__import__()' but should point to 'import()' method function. For example, # 'import statement' entry at index for 'i' on the following page python-2.7.5-docs-html/genindex-I.html # points to python-2.7.5-docs-html/library

[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

[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

[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