GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-95913: Copyedit & xref FrameInfo in Whatsnew inspect section by CAM-Gerlach · Pull Request #98304 · python/cpython

Conversation

@CAM-Gerlach

@CAM-Gerlach CAM-Gerlach commented Oct 15, 2022 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

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
  • Issue: Edit What's New for Python 3.11 #95913

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
CAM-Gerlach added 2 commits October 15, 2022 16:16
@CAM-Gerlach
Break fn list in inspect into bullets and tweak syntax/formatting
390bd32
@CAM-Gerlach
Explictly name and reference the new inspect.FrameInfo objects
61b9ce5
@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 15, 2022
@CAM-Gerlach
CAM-Gerlach requested review from ezio-melotti and pablogsal October 15, 2022 21:24
@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
Edit What's New for Python 3.11 #95913
Closed
31 of 33 tasks
@CAM-Gerlach
CAM-Gerlach requested a review from 1st1 October 16, 2022 02:21
CAM-Gerlach added 3 commits October 15, 2022 21:47
@CAM-Gerlach
Add mention of inspect.Traceback to entry & further clarify
940e5b8
@CAM-Gerlach
Add vchanged in inspect for Traceback & edit/indent properly
2aa2ed9
@CAM-Gerlach
Add missing versionadded to inspect.ismethodwrapper & fix Sphinx syntax
4b7ac24
@pablogsal
pablogsal merged commit 8f30267 into python:main Oct 22, 2022
@miss-islington

miss-islington commented Oct 22, 2022

Copy link
Copy Markdown
Contributor

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-bot bedevere-bot removed the awaiting review label Oct 22, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 22, 2022
@CAM-Gerlach @miss-islington
pythongh-95913: Copyedit & xref FrameInfo in Whatsnew inspect section (…
84fbc17
…pythonGH-98304)

(cherry picked from commit 8f30267)

Co-authored-by: C.A.M. Gerlach <[email protected]>
@bedevere-bot

bedevere-bot commented Oct 22, 2022

Copy link
Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@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
@miss-islington @CAM-Gerlach
gh-95913: Copyedit & xref FrameInfo in Whatsnew inspect section (GH-9…
519b56a
…8304)

(cherry picked from commit 8f30267)

Co-authored-by: C.A.M. Gerlach <[email protected]>
pablogsal pushed a commit that referenced this pull request Oct 22, 2022
@miss-islington @CAM-Gerlach @pablogsal
gh-95913: Copyedit & xref FrameInfo in Whatsnew inspect section (GH-9…
f8f0386
…8304)

(cherry picked from commit 8f30267)

Co-authored-by: C.A.M. Gerlach <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pablogsal pablogsal Awaiting requested review from pablogsal
@ezio-melotti ezio-melotti Awaiting requested review from ezio-melotti
@1st1 1st1 Awaiting requested review from 1st1

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

3.11 only security fixes docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@CAM-Gerlach @miss-islington @bedevere-bot @pablogsal
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.