René's URL Explorer Experiment


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

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

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

Description: This PR fixes the misleading documentation for generator.close() that incorrectly stated the method 'raises a GeneratorExit' to the caller. Problem The current documentation in both Doc/reference/expressions.rst and Doc/howto/functional.rst states that generator.close() 'raises a GeneratorExit' which is misleading because: The method sends the GeneratorExit exception to the generator internally The method returns None to the caller The method does not raise the exception to the caller Solution Changed 'raises' to 'sends' in both documentation files for accuracy and consistency: Doc/reference/expressions.rst (line 628-629): Before: 'Raises a GeneratorExit at the point where the generator function was paused' After: 'Sends a GeneratorExit exception to the generator at the point where the generator function was paused' Doc/howto/functional.rst (line 605): Before: 'raises a GeneratorExit exception inside the' After: 'sends a GeneratorExit exception inside the' Testing The behavior described in the fixed documentation can be verified by the examples in the original issue report, which show that generator.close() always returns None. Fixes #135110 📚 Documentation preview 📚: https://cpython-previews--135152.org.readthedocs.build/ Issue: gh-135110

Open Graph Description: This PR fixes the misleading documentation for generator.close() that incorrectly stated the method 'raises a GeneratorExit' to the caller. Problem The current documentation in both Doc/ref...

X Description: This PR fixes the misleading documentation for generator.close() that incorrectly stated the method 'raises a GeneratorExit' to the caller. Problem The current documentation in both...

Opengraph URL: https://github.com/python/cpython/pull/135152

X: @github

direct link

Domain: github.com

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/:user_id/:repository/pull/:id/files(.:format)
route-controllerpull_requests
route-actionfiles
fetch-noncev2:90458fac-10d7-11af-6461-ab99dd0e98fb
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-idC28A:1AE20C:4805D1D:5B015BD:6B02388F
html-safe-nonce9b1f64b5b150795fe9ff3f914acd7763df4869ec39c738eca5290f6862b7b929
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDMjhBOjFBRTIwQzo0ODA1RDFEOjVCMDE1QkQ6NkIwMjM4OEYiLCJ2aXNpdG9yX2lkIjoiNjQ3NjAzNDA2ODE3Njg0NDk0MyIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmacc7a5a1d47aab704d59e0417b410e9a505b0d235641e8e3d56f676ccbe54c9acb
hovercard-subject-tagpull_request:2568663244
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///pull_requests/show/files
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/python/cpython/pull/135152/files
twitter:imagehttps://avatars.githubusercontent.com/u/188690869?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/188690869?s=400&v=4
og:image:altThis PR fixes the misleading documentation for generator.close() that incorrectly stated the method 'raises a GeneratorExit' to the caller. Problem The current documentation in both Doc/ref...
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
None87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456
turbo-cache-controlno-preview
diff-viewunified
go-importgithub.com/python/cpython git https://github.com/python/cpython.git
octolytics-dimension-user_id1525981
octolytics-dimension-user_loginpython
octolytics-dimension-repository_id81598961
octolytics-dimension-repository_nwopython/cpython
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id81598961
octolytics-dimension-repository_network_root_nwopython/cpython
turbo-body-classeslogged-out env-production page-responsive full-width
disable-turbotrue
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release423dbb54c5e7bfecc838eb387c1435eb3d0e760d
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/python/cpython/pull/135152/files#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fcpython%2Fpull%2F135152%2Ffiles
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fcpython%2Fpull%2F135152%2Ffiles
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=python%2Fcpython
Reloadhttps://github.com/python/cpython/pull/135152/files
Reloadhttps://github.com/python/cpython/pull/135152/files
Reloadhttps://github.com/python/cpython/pull/135152/files
pythonhttps://github.com/python
cpythonhttps://github.com/python/cpython
Codehttps://github.com/python/cpython
Issues5k+ (5k+)https://github.com/python/cpython/issues
Pull requests2.4k (2.4k)https://github.com/python/cpython/pulls
Actionshttps://github.com/python/cpython/actions
Projectshttps://github.com/python/cpython/projects
Security and qualityhttps://github.com/python/cpython/security
Insightshttps://github.com/python/cpython/insights
Sign up for GitHub https://github.com/signup?return_to=%2Fpython%2Fcpython%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://github.com/login?return_to=%2Fpython%2Fcpython%2Fissues%2Fnew%2Fchoose
ZeroIntensityhttps://github.com/ZeroIntensity
python:mainhttps://github.com/python/cpython/tree/main
Conversation 9 https://github.com/python/cpython/pull/135152
Commits 6 https://github.com/python/cpython/pull/135152/commits
Checks 0 https://github.com/python/cpython/pull/135152/checks
Files changed https://github.com/python/cpython/pull/135152/files
Please reload this pagehttps://github.com/python/cpython/pull/135152/files
gh-135110: Fix misleading generator.close() documentation https://github.com/python/cpython/pull/135152/files#top
Show all changes 6 commits https://github.com/python/cpython/pull/135152/files
66a86e1 Fix misleading generator.close() documentation cdenihan Jun 4, 2025 https://github.com/python/cpython/pull/135152/commits/66a86e1246e3853adac4a7e7e111f67c49ca235f
fe86c40 Doc: Clarify generator.close() documentation cdenihan Jun 20, 2025 https://github.com/python/cpython/pull/135152/commits/fe86c406ded58552a09957cf6112140c92a44675
941816a Remove trailing whitespace cdenihan Jun 20, 2025 https://github.com/python/cpython/pull/135152/commits/941816aea3c59c727f43bc385175623bab2127c8
bad5fe5 Update functional.rst cdenihan Jun 20, 2025 https://github.com/python/cpython/pull/135152/commits/bad5fe5c9768d76c80d28aaec1a2d61b57f8ac41
89d6298 Merge branch 'main' into fix-generator-close-docs cdenihan Jun 20, 2025 https://github.com/python/cpython/pull/135152/commits/89d6298c4377beec0f5a14fb02371d4584d12e5e
1b11152 Merge branch 'main' into fix-generator-close-docs cdenihan Jun 21, 2025 https://github.com/python/cpython/pull/135152/commits/1b111524cf598c208e5d02888fcb5daf1355cd0a
Clear filters https://github.com/python/cpython/pull/135152/files
Please reload this pagehttps://github.com/python/cpython/pull/135152/files
Please reload this pagehttps://github.com/python/cpython/pull/135152/files
functional.rst https://github.com/python/cpython/pull/135152/files#diff-9cd11eca066cfdebdf5b8d07ccf1508549bbdb0c615feb859910eb20f23581d0
expressions.rst https://github.com/python/cpython/pull/135152/files#diff-c7ab338b9f88f5c444cde36aa48132cf5534500c6969a3fd2c7680234e87afd6
Doc/howto/functional.rsthttps://github.com/python/cpython/pull/135152/files#diff-9cd11eca066cfdebdf5b8d07ccf1508549bbdb0c615feb859910eb20f23581d0
View file https://github.com/python/cpython/blob/1b111524cf598c208e5d02888fcb5daf1355cd0a/Doc/howto/functional.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python/cpython/pull/135152/{{ revealButtonHref }}
https://github.com/python/cpython/pull/135152/files#diff-9cd11eca066cfdebdf5b8d07ccf1508549bbdb0c615feb859910eb20f23581d0
https://github.com/python/cpython/pull/135152/files#diff-9cd11eca066cfdebdf5b8d07ccf1508549bbdb0c615feb859910eb20f23581d0
https://github.com/python/cpython/blob/main/.github/CODEOWNERS#L115
Doc/reference/expressions.rsthttps://github.com/python/cpython/pull/135152/files#diff-c7ab338b9f88f5c444cde36aa48132cf5534500c6969a3fd2c7680234e87afd6
View file https://github.com/python/cpython/blob/1b111524cf598c208e5d02888fcb5daf1355cd0a/Doc/reference/expressions.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python/cpython/pull/135152/{{ revealButtonHref }}
https://github.com/python/cpython/pull/135152/files#diff-c7ab338b9f88f5c444cde36aa48132cf5534500c6969a3fd2c7680234e87afd6
https://github.com/python/cpython/pull/135152/files#diff-c7ab338b9f88f5c444cde36aa48132cf5534500c6969a3fd2c7680234e87afd6
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.