[issue24650] Error in yield expression documentation

[Irit Katriel]

Change by Irit Katriel :


--
resolution:  -> fixed
stage: patch review -> 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

[issue24650] Error in yield expression documentation

[miss-islington]

miss-islington  added the comment:


New changeset 75a1865d1ce352909ad9a30d001486bbd7d3ed75 by Miss Islington (bot) 
in branch '3.10':
[3.10] bpo-24650: Use full term "generator function" in yield expressions docs 
(GH-24663) (GH-30461)
https://github.com/python/cpython/commit/75a1865d1ce352909ad9a30d001486bbd7d3ed75


--

___
Python tracker 

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

[issue24650] Error in yield expression documentation

[miss-islington]

miss-islington  added the comment:


New changeset 8bc68140cbe8230cf048bc04faf927c1413066d1 by Miss Islington (bot) 
in branch '3.9':
bpo-24650: Use full term "generator function" in yield expressions docs 
(GH-24663)
https://github.com/python/cpython/commit/8bc68140cbe8230cf048bc04faf927c1413066d1


--

___
Python tracker 

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

[issue24650] Error in yield expression documentation

[Irit Katriel]

Irit Katriel  added the comment:


New changeset 273cb8e7577d143830404f6779946a0bedb58758 by Jacob Walls in branch 
'main':
bpo-24650: Use full term "generator function" in yield expressions docs 
(GH-24663)
https://github.com/python/cpython/commit/273cb8e7577d143830404f6779946a0bedb58758


--
nosy: +iritkatriel

___
Python tracker 

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

[issue24650] Error in yield expression documentation

[miss-islington]

Change by miss-islington :


--
pull_requests: +28665
pull_request: https://github.com/python/cpython/pull/30462

___
Python tracker 

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

[issue24650] Error in yield expression documentation

[miss-islington]

Change by miss-islington :


--
nosy: +miss-islington
nosy_count: 5.0 -> 6.0
pull_requests: +28664
pull_request: https://github.com/python/cpython/pull/30461

___
Python tracker 

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

[issue24650] Error in yield expression documentation

[Irit Katriel]

Change by Irit Katriel :


--
versions: +Python 3.11, Python 3.9

___
Python tracker 

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

[issue24650] Error in yield expression documentation

[Jacob Walls]

Change by Jacob Walls :


--
keywords: +patch
nosy: +jacobtylerwalls
nosy_count: 4.0 -> 5.0
pull_requests: +23449
stage: needs patch -> patch review
pull_request: https://github.com/python/cpython/pull/24663

___
Python tracker 

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

[issue24650] Error in yield expression documentation

[Irit Katriel]

Change by Irit Katriel :


--
keywords: +easy
versions: +Python 3.10 -Python 3.3, Python 3.4, Python 3.5, Python 3.6

___
Python tracker 

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

[issue24650] Error in yield expression documentation

[swanson]

New submission from swanson:

https://docs.python.org/3/reference/expressions.html

in
6.2.9. Yield expressions

end of 1st paragraph:

Using a yield expression in a function’s body causes that function to be a 
generator.

NO!

As the very next sentence explains, a generator is what's returned by such a 
function, not the function itself.

Basically, it should be sufficient to add the word function to the end of 
that sentence: ... generator function.  However, this error does NOT exist in 
3.0 to 3.2 - just in 3.3 to 3.6, so I suggest just using the same wording as 
3.0 to 3.2:

Using a yield expression in a function definition is sufficient to cause that 
definition to create a generator function instead of a normal function.

--
assignee: docs@python
components: Documentation
messages: 246841
nosy: docs@python, swanson
priority: normal
severity: normal
status: open
title: Error in yield expression documentation
versions: Python 3.3, Python 3.4, Python 3.5, Python 3.6

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

[issue24650] Error in yield expression documentation

[swanson]

swanson added the comment:

Okay, interesting - I hadn't checked the glossary.  I don't ultimately care 
what it's called as long as the documentation is clear and consistent.  But for 
anyone just looking at the names of the classes and the class hierarchy, they'd 
come away saying, A generator is a type of iterator, not A generator is a 
type of function.  (Functions can't even have subtypes.)  If the docs are 
painting a different picture than the already existing reality, it seems like 
that would be confusing to anyone who doesn't already know how they work.  (If 
you already know how something works, you don't really need the docs, so it's 
easy to think they're clearer than they really are.)

--

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

[issue24650] Error in yield expression documentation

[Martin Panter]

Martin Panter added the comment:

Technically, the glossary defines the unqualified term “generator” as the 
factory function: https://docs.python.org/3.5/glossary.html#term-generator. 
(The 3.6 documentation should say the same but the build has been broken or out 
of date for a few months.) Though I agree adding the old wording would make it 
clearer.

The 3.3 change was made in revision e02da391741f for Issue 12704.

--
nosy: +nikratio, vadmium
stage:  - needs patch

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