Skip to content

Conversation

@CAM-Gerlach
Copy link
Member

@CAM-GerlachCAM-Gerlach commented Oct 15, 2022

Part of #95913

This applies the standard copyediting and formatting to the inspect section in the Python 3.11 What's New, as well as explicitly mentions/references the new inspect.FrameInfo objects. Specifically:

  • Explicitly name and link the new FrameInfo/Traceback class instances returned by various inspect functions and what it replaces (a namedtuple-like object)
  • Break prose list of functions into bulleted list for readability
  • Don't show redundant module name in inspect module APIs
  • Other small Sphinx/textual tweaks

Also, it makes a couple directly related fixes in the inspect module library documentation:

  • Add missing "Changed in 3.11" annotation to inspect.Traceback
  • Fix indent and wording of that under inspect.FrameInfo
  • Add missing "New in 3.11" annotation to inspect.ismethodwrapper mentioned in What's New, and fix broken cross-references within due to bad Sphinx syntax

@bedevere-botbedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 15, 2022
@CAM-GerlachCAM-Gerlach added 3.11 only security fixes needs backport to 3.11 only security fixes labels Oct 15, 2022
@CAM-GerlachCAM-Gerlach mentioned this pull request Oct 15, 2022
33 tasks
@CAM-GerlachCAM-Gerlach requested a review from 1st1October 16, 2022 02:21
@pablogsalpablogsal merged commit 8f30267 into python:mainOct 22, 2022
@miss-islington
Copy link
Contributor

Thanks @CAM-Gerlach for the PR, and @pablogsal for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 22, 2022
…pythonGH-98304) (cherry picked from commit 8f30267) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@bedevere-bot
Copy link

GH-98553 is a backport of this pull request to the 3.11 branch.

@bedevere-botbedevere-bot removed the needs backport to 3.11 only security fixes label Oct 22, 2022
miss-islington added a commit that referenced this pull request Oct 22, 2022
…8304) (cherry picked from commit 8f30267) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this pull request Oct 22, 2022
…8304) (cherry picked from commit 8f30267) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3.11only security fixesdocsDocumentation in the Doc dirskip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@CAM-Gerlach@miss-islington@bedevere-bot@pablogsal