Navigation Menu

Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

yield's documentation not updated #49242

Closed
encukou opened this issue Jan 18, 2009 · 3 comments
Closed

yield's documentation not updated #49242

encukou opened this issue Jan 18, 2009 · 3 comments
Assignees
@birkenfeld
Labels
docs Documentation in the Doc dir

Comments

@encukou
Copy link
Member

encukou commented Jan 18, 2009

BPO 4992
Nosy @birkenfeld, @terryjreedy, @encukou

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = 'https://github.com/birkenfeld'
closed_at = <Date 2009-02-05.11:02:22.454>
created_at = <Date 2009-01-18.22:55:11.918>
labels = ['docs']
title = "yield's documentation not updated"
updated_at = <Date 2009-02-05.11:02:22.453>
user = 'https://github.com/encukou'

bugs.python.org fields:

activity = <Date 2009-02-05.11:02:22.453>
actor = 'georg.brandl'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2009-02-05.11:02:22.454>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2009-01-18.22:55:11.918>
creator = 'petr.viktorin'
dependencies = []
files = []
hgrepos = []
issue_num = 4992
keywords = []
message_count = 3.0
messages = ['80134', '80427', '81203']
nosy_count = 3.0
nosy_names = ['georg.brandl', 'terry.reedy', 'petr.viktorin']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue4992'
versions = ['Python 3.0']
@encukou
Copy link
Member Author

encukou commented Jan 18, 2009

In the yield statement documentation
(http://docs.python.org/3.0/reference/simple_stmts.html#the-yield-statement),
the old way of calling generators is used:

"The body of the generator function is executed by calling the
generator’s next() method repeatedly until it raises an exception."

This should be changed to something like:

"The body of the generator function is executed by calling the next()
function on the generator repeatedly until it raises an exception."

Or just replace next() with __next__(), and fix the next paragraph as well.

@encukou encukou added the docs Documentation in the Doc dir label Jan 18, 2009
@terryjreedy
Copy link
Member

I would go with the first suggestion as that was the intent of adding
next() as a builtin function.

@birkenfeld
Copy link
Member

Thanks, fixed in r69294.

@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@birkenfeld birkenfeld

Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@birkenfeld @encukou @terryjreedy