Skip to content

gh-62172: Document classify_class_attrs(), getabsfile(), and indentsize() in inspect#153624

Open
sreehariannam wants to merge 3 commits into
python:mainfrom
sreehariannam:gh-62172-inspect-docs
Open

gh-62172: Document classify_class_attrs(), getabsfile(), and indentsize() in inspect#153624
sreehariannam wants to merge 3 commits into
python:mainfrom
sreehariannam:gh-62172-inspect-docs

Conversation

@sreehariannam

Copy link
Copy Markdown

Adds documentation for three public, __all__-exported functions in the inspect module that were missing from Doc/library/inspect.rst:

  • inspect.getabsfile()
  • inspect.indentsize()
  • inspect.classify_class_attrs()

Towards gh-62172. That issue lists several other undocumented functions (findsource, getblock, walktree, getargs, formatannotation, formatannotationrelativeto, getlineno) which are left for a follow-up PR to keep this change small and reviewable.

Verified with sphinx-lint (no issues) against the current Doc/library/inspect.rst.

@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Jul 12, 2026
@python-cla-bot

python-cla-bot Bot commented Jul 12, 2026

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

CLA signed

@read-the-docs-community

read-the-docs-community Bot commented Jul 12, 2026

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33552363 | 📁 Comparing 607db18 against main (dd2faeb)

  🔍 Preview build  

2 files changed
± library/inspect.html
± whatsnew/changelog.html

Comment thread Doc/library/inspect.rst Outdated
Comment thread Doc/library/inspect.rst Outdated
@sreehariannam

Copy link
Copy Markdown
Author

Thanks for the review! Addressed both points in the latest commit: dropped the normcase implementation detail from getabsfile's description, and linked named tuple via :term: in classify_class_attrs.

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

Labels

awaiting core review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants