FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-135110: Fix misleading generator.close() documentation by cdenihan · Pull Request #135152 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-135110: Fix misleading generator.close() documentation #135152

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.

Sign up for GitHub

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

Merged
ZeroIntensity merged 6 commits into from
Jun 26, 2025
Conversation 9 Commits 6 Checks 0 Files changed
Merged

gh-135110: Fix misleading generator.close() documentation #135152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
66a86e1
Fix misleading generator.close() documentation
cdenihan Jun 4, 2025
fe86c40
Doc: Clarify generator.close() documentation
cdenihan Jun 20, 2025
941816a
Remove trailing whitespace
cdenihan Jun 20, 2025
bad5fe5
Update functional.rst
cdenihan Jun 20, 2025
89d6298
Merge branch 'main' into fix-generator-close-docs
cdenihan Jun 20, 2025
1b11152
Merge branch 'main' into fix-generator-close-docs
cdenihan Jun 21, 2025
File filter

Filter by extension

Filter by extension .rst  (2) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
2 changes: 1 addition & 1 deletion Doc/howto/functional.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -602,7 +602,7 @@ generators:
raise an exception inside the generator; the exception is raised by the
``yield`` expression where the generator's execution is paused.

* :meth:`~generator.close` raises a :exc:`GeneratorExit` exception inside the
* :meth:`~generator.close` sends a :exc:`GeneratorExit` exception to the
generator to terminate the iteration. On receiving this exception, the
generator's code must either raise :exc:`GeneratorExit` or
:exc:`StopIteration`; catching the exception and doing anything else is
Expand Down
6 changes: 4 additions & 2 deletions Doc/reference/expressions.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -625,8 +625,10 @@ is already executing raises a :exc:`ValueError` exception.

.. method:: generator.close()

Raises a :exc:`GeneratorExit` at the point where the generator function was
paused. If the generator function catches the exception and returns a
Raises a :exc:`GeneratorExit` exception at the point where the generator
function was paused (equivalent to calling ``throw(GeneratorExit)``).
The exception is raised by the yield expression where the generator was paused.
If the generator function catches the exception and returns a
value, this value is returned from :meth:`close`. If the generator function
is already closed, or raises :exc:`GeneratorExit` (by not catching the
exception), :meth:`close` returns :const:`None`. If the generator yields a
Expand Down
Back | FazBrowse Home | New Git URL