gh-138191: Document `frame.f_generator` in the data model - #138540

Merged

AA-Turner merged 6 commits into

python:mainfrom

dbXD320:doc-add-f_generator

Sep 5, 2025

dbXD320 commented Sep 5, 2025•
edited by github-actions Bot
Loading

Contributor

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.

Issue: Datamodel's description of frameobject missing the new f_generator attribute #138191

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

Docs: add f_generator attribute to datamodel page and update index

cd69f5b

dbXD320 requested review from AA-Turner and willingc as code owners

September 5, 2025 13:18

python-cla-botBot commented Sep 5, 2025•
edited
Loading

All commit authors signed the Contributor License Agreement.

bedevere-appBot added awaiting review docs skip news labels

github-project-automationBot added this to Docs PRs

github-project-automationBot moved this to Todo in Docs PRs

bedevere-appBot mentioned this pull request

Datamodel's description of frameobject missing the new f_generator attribute #138191

Closed

AA-Turner reviewed

View reviewed changes

Doc/reference/datamodel.rst Outdated

Docs: move f_generator attribute to end of datamodel page

c8c9956

ZeroIntensity reviewed

View reviewed changes

Doc/reference/datamodel.rst Outdated

AA-Turner reviewed

View reviewed changes

Doc/reference/datamodel.rst Outdated

Update Doc/reference/datamodel.rst

143a22d

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

AA-Turner changed the title ~~gh-138191: Add f_generator attribute to datamodel page~~ gh-138191: Document frame.f_generator in the data model

AA-Turner approved these changes

View reviewed changes

bedevere-appBot added awaiting merge and removed awaiting review labels

AA-Turner reviewed

View reviewed changes

Doc/reference/datamodel.rst

Update Doc/reference/datamodel.rst

5d85385

AA-Turner added the needs backport to 3.14 label

AA-Turner reviewed

View reviewed changes

Doc/reference/datamodel.rst Outdated

whitespace

fdad13a

AA-Turner reviewed

View reviewed changes

Doc/reference/datamodel.rst

whitespace

7e44b33

AA-Turner enabled auto-merge (squash)

September 5, 2025 17:07

AA-Turner merged commit e5c5830 into python:main

27 checks passed

github-project-automationBot moved this from Todo to Done in Docs PRs

miss-islington-appBot commented Sep 5, 2025

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

bedevere-appBot removed the awaiting merge label

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request

pythongh-138191: Documentframe.f_generatorin the data model (py…

12934f9

…thonGH-138540)
(cherry picked from commit e5c5830)
Co-authored-by: dbXD320 <devanshbaghla320@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

bedevere-appBot commented Sep 5, 2025

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

bedevere-appBot removed the needs backport to 3.14 label

hugovk pushed a commit that referenced this pull request

[3.14]gh-138191: Documentframe.f_generatorin the data model (G…

1e1bfe7

…H-138540) (#138553)
Co-authored-by: dbXD320 <devanshbaghla320@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

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

[3.14]pythongh-138191: Documentframe.f_generatorin the data mo…

718e383

…del (pythonGH-138540) (python#138553)
Co-authored-by: dbXD320 <devanshbaghla320@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

lkollar pushed a commit to lkollar/cpython that referenced this pull request

pythongh-138191: Documentframe.f_generatorin the data model (py…

a76f691

…thon#138540)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels