[issue14878] send statement from PEP342 is poorly documented.

2012-05-21 Thread Stephen Lacy

New submission from Stephen Lacy :

There's reasonable documentation of the yield statement for most python 
versions under Section 6: Simple Statements, particularly 6.8 "The Yield 
Statement" 
(http://docs.python.org/release/2.7/reference/simple_stmts.html#the-yield-statement)

But, there's no mention of the return value of the yield statement, or that the 
send statement even exists.  It's mentioned in passing here under "PEP342 New 
Generator Features" 
(http://docs.python.org/whatsnew/2.5.html#pep-342-new-generator-features) but 
should be given fuller explanation and cross-linking from the yield statement 
documentation. 

It's also mentioned a bit here: 
http://docs.python.org/howto/functional.html#passing-values-into-a-generator 
but again, not under the language documentation itself.

--
assignee: docs@python
components: Documentation
messages: 161320
nosy: Stephen.Lacy, docs@python
priority: normal
severity: normal
status: open
title: send statement from PEP342 is poorly documented.
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4

___
Python tracker 
<http://bugs.python.org/issue14878>
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com



[issue14878] send statement from PEP342 is poorly documented.

2012-05-22 Thread Stephen Lacy

Stephen Lacy  added the comment:

okay, found the documentation I was looking for here:

http://docs.python.org/reference/expressions.html#yield-expressions

which appears to be copied and pasted and modified version of the docs here:

http://docs.python.org/reference/simple_stmts.html#grammar-token-yield_stmt

At the very least these should cross-reference each other, but I would guess 
that the text should be unified, but I'm not sure where.

--

___
Python tracker 
<http://bugs.python.org/issue14878>
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com