gh-62172: Document findsource() and getblock() in inspect#153628
Open
sreehariannam wants to merge 1 commit into
Open
gh-62172: Document findsource() and getblock() in inspect#153628sreehariannam wants to merge 1 commit into
sreehariannam wants to merge 1 commit into
Conversation
Documentation build overview
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Continues gh-62172 (see #153624 for the first batch:
classify_class_attrs,getabsfile,indentsize). This adds documentation for two more public,__all__-exportedinspectfunctions that were missing fromDoc/library/inspect.rst:inspect.findsource()inspect.getblock()There was an earlier attempt at documenting
findsourcein #6992, which a core reviewer approved with a minor suggestion (mention thatfindsourcedoesn't unwrap decorated callables likegetsourcelinesdoes) before it went stale and was closed. That suggestion is incorporated here.Remaining undocumented functions from gh-62172 (
walktree,getargs,formatannotation,formatannotationrelativeto,getlineno) are left for follow-up PRs to keep this reviewable.Verified with
sphinx-lint(no issues).