GeezerVison

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

GeezerVison is showing github.com — gh-101578: Amend PyErr_{Set,Get}RaisedException docs by erlend-aasland · Pull Request #101962 · python/cpython

Conversation

erlend-aasland commented Feb 16, 2023 •

edited

Loading

Uh oh!

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

Copy link

Copy Markdown

Contributor

Issue: PyErr_SetObject() behavior is strange and not as documented. #101578

Sorry, something went wrong.

Uh oh!

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

CAM-Gerlach reacted with thumbs up emoji

All reactions

👍 1 reaction


          pythongh-101578: Amend PyErr_{Set,Get}RaisedException docs

fd0dde1

erlend-aasland requested review from CAM-Gerlach, iritkatriel and markshannon

February 16, 2023 21:30

bedevere-bot added the awaiting core review label

Feb 16, 2023

bedevere-bot mentioned this pull request

Feb 16, 2023

PyErr_SetObject() behavior is strange and not as documented. #101578

Closed

erlend-aasland commented Feb 16, 2023

Copy link

Copy Markdown

Contributor Author

I removed the duplicate example; it should be sufficient to provide a single example.
Use note:: to put emphasis on non-standard reference count semantics in the set function.
Mark the getter as returning a borrowed reference.
Apply Diátaxis: be succinct and to the point (and hopefully also clearer)

CAM-Gerlach reacted with thumbs up emoji

All reactions

👍 1 reaction

Sorry, something went wrong.

Uh oh!

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

erlend-aasland added the skip news label

Feb 16, 2023

erlend-aasland commented

Feb 16, 2023

View reviewed changes

Comment thread

Doc/c-api/exceptions.rst Resolved

Uh oh!

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

CAM-Gerlach added the docs Documentation in the Doc dir label

Feb 17, 2023

CAM-Gerlach reviewed

Feb 17, 2023

View reviewed changes

CAM-Gerlach left a comment

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @erlend-aasland ; this is a substantial improvement to the previous docs.

Perhaps its worth fixing the other couple remaining similar docs defects also introduced in PR #101607 , namely in the descriptions of the newly documented functions PyException_GetArgs and PyException_SetArgs (that could use a similar (if much simpler) treatment as here), and the deprecation notices added to PyErr_Fetch, PyErr_Restore and PyErr_NormalizeException not being added to, and particularly duplicating, the .. deprecated directive.

Sorry, something went wrong.

Uh oh!

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

All reactions

Comment thread

Doc/c-api/exceptions.rst Resolved

Uh oh!

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

Comment thread

Doc/c-api/exceptions.rst Resolved

Uh oh!

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

Comment thread

Doc/c-api/exceptions.rst Resolved

Uh oh!

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

Comment thread

Doc/c-api/exceptions.rst Resolved

Uh oh!

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

Comment thread

Doc/c-api/exceptions.rst Resolved

Uh oh!

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


          Address CAM's first round of review

415a70d

erlend-aasland requested a review from CAM-Gerlach

February 17, 2023 08:32

erlend-aasland commented Feb 17, 2023

Copy link

Copy Markdown

Contributor Author

Thanks @erlend-aasland ; this is a substantial improvement to the previous docs.

Thanks, and thanks for the review!

Perhaps its worth fixing the other couple remaining similar docs defects also introduced in PR #101607 , namely in the descriptions of the newly documented functions PyException_GetArgs and PyException_SetArgs (that could use a similar (if much simpler) treatment as here), and the deprecation notices added to PyErr_Fetch, PyErr_Restore and PyErr_NormalizeException not being added to, and particularly duplicating, the .. deprecated directive.

Definitely; perhaps as a follow-up PR?

CAM-Gerlach reacted with thumbs up emoji

All reactions

👍 1 reaction

Sorry, something went wrong.

Uh oh!

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

CAM-Gerlach commented Feb 17, 2023

Copy link

Copy Markdown

Member

Definitely; perhaps as a follow-up PR?

Yeah certainly could be; up to you, of course

All reactions

Sorry, something went wrong.

Uh oh!

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

CAM-Gerlach reviewed

Feb 17, 2023

View reviewed changes

CAM-Gerlach left a comment

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple followup suggestions

Sorry, something went wrong.

Uh oh!

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

All reactions

Comment thread

Doc/c-api/exceptions.rst Resolved

Uh oh!

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

Comment thread

Doc/c-api/exceptions.rst Resolved

Uh oh!

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

Comment thread

Doc/c-api/exceptions.rst Resolved

Uh oh!

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


          Address CAM's second round of review

45ecfe5

erlend-aasland requested a review from CAM-Gerlach

February 17, 2023 10:13

erlend-aasland added 2 commits

February 17, 2023 11:26


          Move seealso to get API

02334f4


          Fixup seealo, hopefully for real this time

3cf91f8

CAM-Gerlach approved these changes

Feb 17, 2023

View reviewed changes

CAM-Gerlach left a comment

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM from me; thanks @erlend-aasland !

Sorry, something went wrong.

Uh oh!

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

erlend-aasland reacted with hooray emoji

All reactions

🎉 1 reaction

erlend-aasland commented Feb 17, 2023

Copy link

Copy Markdown

Contributor Author

Thanks for the review, CAM; highly appreciated. I'll wait for @iritkatriel's or @markshannon's approval before landing.

All reactions

Sorry, something went wrong.

Uh oh!

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

iritkatriel reviewed

Feb 17, 2023

View reviewed changes

Comment thread

Doc/c-api/exceptions.rst Resolved

Uh oh!

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

iritkatriel reviewed

Feb 18, 2023

View reviewed changes

Comment thread

Doc/c-api/exceptions.rst Resolved

Uh oh!

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


          Update Doc/c-api/exceptions.rst

fd94dd8

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

erlend-aasland commented Feb 19, 2023

Copy link

Copy Markdown

Contributor Author

Thanks for the reviews, Irit and CAM; highly appreciated. I'll create a follow-up PR Any Time Soon™.

CAM-Gerlach reacted with thumbs up emoji

All reactions

👍 1 reaction

Sorry, something went wrong.

Uh oh!

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

erlend-aasland added 🤖 automerge and removed 🤖 automerge labels

Feb 19, 2023

erlend-aasland merged commit 60bbed7 into python:main

Feb 19, 2023

bedevere-bot removed the awaiting core review label

Feb 19, 2023

erlend-aasland deleted the fixup-exc-docs branch

February 19, 2023 20:22

erlend-aasland mentioned this pull request

Feb 19, 2023

gh-101578: Amend exception docs #102057

Merged

erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request

Feb 19, 2023


          pythongh-101578: Amend exception docs

3a4a570

Follow-up to pythongh-101962

jaraco pushed a commit to jaraco/cpython that referenced this pull request

Feb 20, 2023


          pythongh-101578: Amend PyErr_{Set,Get}RaisedException docs (python#10…

a0004e1

…1962)

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

jaraco mentioned this pull request

Feb 20, 2023

gh-88233: zipfile: refactor _strip_extra #102083

Closed

carljm added a commit to carljm/cpython that referenced this pull request

Feb 20, 2023


          Merge branch 'main' into inlinecomp2

9f0fc5b

* main: (60 commits)
  pythongh-102056: Fix a few bugs in error handling of exception printing code (python#102078)
  pythongh-102011: use sys.exception() instead of sys.exc_info() in docs where possible (python#102012)
  pythongh-101566: Sync with zipp 3.14. (pythonGH-102018)
  pythonGH-99818: improve the documentation for zipfile.Path and Traversable (pythonGH-101589)
  pythongh-88233: zipfile: handle extras after a zip64 extra (pythonGH-96161)
  pythongh-101981: Apply HOMEBREW related environment variables (pythongh-102074)
  pythongh-101907: Stop using `_Py_OPCODE` and `_Py_OPARG` macros (pythonGH-101912)
  pythongh-101819: Adapt _io types to heap types, batch 1 (pythonGH-101949)
  pythongh-101981: Build macOS as recommended by the devguide (pythonGH-102070)
  pythongh-97786: Fix compiler warnings in pytime.c (python#101826)
  pythongh-101578: Amend PyErr_{Set,Get}RaisedException docs (python#101962)
  Misc improvements to the float tutorial (pythonGH-102052)
  pythongh-85417: Clarify behaviour on branch cuts in cmath module (python#102046)
  pythongh-100425: Update tutorial docs related to sum() accuracy (FH-101854)
  Add missing 'is' to `cmath.log()` docstring (python#102049)
  pythongh-100210: Correct the comment link for unescaping HTML (python#100212)
  pythongh-97930: Also include subdirectory in makefile. (python#102030)
  pythongh-99735: Use required=True in argparse subparsers example (python#100927)
  Fix incorrectly documented attribute in csv docs (python#101250)
  pythonGH-84783: Make the slice object hashable (pythonGH-101264)
  ...

carljm added a commit to carljm/cpython that referenced this pull request

Feb 22, 2023


          Merge branch 'main' into inlinecomp

544b30c

* main: (225 commits)
  pythongh-102056: Fix a few bugs in error handling of exception printing code (python#102078)
  pythongh-102011: use sys.exception() instead of sys.exc_info() in docs where possible (python#102012)
  pythongh-101566: Sync with zipp 3.14. (pythonGH-102018)
  pythonGH-99818: improve the documentation for zipfile.Path and Traversable (pythonGH-101589)
  pythongh-88233: zipfile: handle extras after a zip64 extra (pythonGH-96161)
  pythongh-101981: Apply HOMEBREW related environment variables (pythongh-102074)
  pythongh-101907: Stop using `_Py_OPCODE` and `_Py_OPARG` macros (pythonGH-101912)
  pythongh-101819: Adapt _io types to heap types, batch 1 (pythonGH-101949)
  pythongh-101981: Build macOS as recommended by the devguide (pythonGH-102070)
  pythongh-97786: Fix compiler warnings in pytime.c (python#101826)
  pythongh-101578: Amend PyErr_{Set,Get}RaisedException docs (python#101962)
  Misc improvements to the float tutorial (pythonGH-102052)
  pythongh-85417: Clarify behaviour on branch cuts in cmath module (python#102046)
  pythongh-100425: Update tutorial docs related to sum() accuracy (FH-101854)
  Add missing 'is' to `cmath.log()` docstring (python#102049)
  pythongh-100210: Correct the comment link for unescaping HTML (python#100212)
  pythongh-97930: Also include subdirectory in makefile. (python#102030)
  pythongh-99735: Use required=True in argparse subparsers example (python#100927)
  Fix incorrectly documented attribute in csv docs (python#101250)
  pythonGH-84783: Make the slice object hashable (pythonGH-101264)
  ...

Reviewers

iritkatriel

iritkatriel left review comments

CAM-Gerlach

CAM-Gerlach approved these changes

markshannon

Awaiting requested review from markshannon

Uh oh!

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

Assignees

No one assigned

Labels

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

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.

GeezerVison

Conversation

erlend-aasland commented Feb 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

erlend-aasland commented Feb 16, 2023

Uh oh!

Uh oh!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

erlend-aasland commented Feb 17, 2023

Uh oh!

CAM-Gerlach commented Feb 17, 2023

Uh oh!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

erlend-aasland commented Feb 17, 2023

Uh oh!

Uh oh!

Uh oh!

erlend-aasland commented Feb 19, 2023

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

erlend-aasland commented Feb 16, 2023 •

edited

Loading

Uh oh!

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