Skip to content

Conversation

dbXD320
Copy link
Contributor

@dbXD320 dbXD320 commented Sep 5, 2025

This PR adds the f_generator attribute to the Data model documentation page
(Doc/reference/datamodel.rst).

The f_generator attribute was already described in inspect.rst but was missing
from datamodel.rst. This change ensures that the Data model page is consistent
with the inspection documentation and fully documents all frame object attributes.

Additionally, an index entry for f_generator has been added so it appears in the
documentation search.

fixes #138191


📚 Documentation preview 📚: https://cpython-previews--138540.org.readthedocs.build/

@python-cla-bot
Copy link

python-cla-bot bot commented Sep 5, 2025

All commit authors signed the Contributor License Agreement.

CLA signed

@AA-Turner AA-Turner changed the title gh-138191: Add f_generator attribute to datamodel page gh-138191: Document frame.f_generator in the data model Sep 5, 2025
@AA-Turner AA-Turner added the needs backport to 3.14 bugs and security fixes label Sep 5, 2025
@AA-Turner AA-Turner enabled auto-merge (squash) September 5, 2025 17:07
@AA-Turner AA-Turner merged commit e5c5830 into python:main Sep 5, 2025
27 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Sep 5, 2025
@miss-islington-app
Copy link

Thanks @dbXD320 for the PR, and @AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 5, 2025
…thonGH-138540)

(cherry picked from commit e5c5830)

Co-authored-by: dbXD320 <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Sep 5, 2025

GH-138553 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Sep 5, 2025
hugovk pushed a commit that referenced this pull request Sep 6, 2025
@dbXD320 dbXD320 deleted the doc-add-f_generator branch September 7, 2025 09:06
kumaraditya303 pushed a commit to miss-islington/cpython that referenced this pull request Sep 9, 2025
lkollar pushed a commit to lkollar/cpython that referenced this pull request Sep 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Datamodel's description of frameobject missing the new f_generator attribute
4 participants