Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-95913: Copyedit & xref FrameInfo in Whatsnew inspect section #98304

Merged
merged 5 commits into from
Oct 22, 2022

Conversation

CAM-Gerlach
Copy link
Member

@CAM-Gerlach CAM-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-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 15, 2022
@CAM-Gerlach CAM-Gerlach added 3.11 only security fixes needs backport to 3.11 only security fixes labels Oct 15, 2022
@CAM-Gerlach CAM-Gerlach mentioned this pull request Oct 15, 2022
33 tasks
@CAM-Gerlach CAM-Gerlach requested a review from 1st1 October 16, 2022 02:21
@pablogsal pablogsal merged commit 8f30267 into python:main Oct 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
@bedevere-bot
Copy link

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

@bedevere-bot bedevere-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
pablogsal pushed a commit that referenced this pull request Oct 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.11 only security fixes docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants