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-107298: Add standard exceptions and warnings in the nitpick_ignore list by serhiy-storchaka · Pull Request #108029 · python/cpython

Conversation

@serhiy-storchaka

@serhiy-storchaka serhiy-storchaka commented Aug 16, 2023 •
edited by github-actions Bot
Loading

Uh oh!

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

Copy link
Copy Markdown
Member
  • Issue: Fix Sphinx warnings in the C API documentation #107298

📚 Documentation preview 📚: https://cpython-previews--108029.org.readthedocs.build/

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@serhiy-storchaka
pythongh-107298: Add standard exceptions and warnings in the nitpick_…
f850023 
…ignore list
@serhiy-storchaka serhiy-storchaka added skip news needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Aug 16, 2023
@serhiy-storchaka
serhiy-storchaka requested a review from vstinner August 16, 2023 15:03
@bedevere-bot bedevere-bot mentioned this pull request Aug 16, 2023
Fix Sphinx warnings in the C API documentation #107298
Closed
@bedevere-bot bedevere-bot added the awaiting core review label Aug 16, 2023
AA-Turner
AA-Turner reviewed Aug 16, 2023
View reviewed changes
Comment thread Doc/conf.py Resolved

Uh oh!

There was an error while loading. Please reload this page.
@serhiy-storchaka
Fix extending.
c8cbbc3
AA-Turner
AA-Turner approved these changes Aug 16, 2023
View reviewed changes
vstinner
vstinner reviewed Aug 16, 2023
View reviewed changes
Comment thread Doc/conf.py
]

# Temporary undocumented names.
# In future this list must be empty.

@vstinner vstinner Aug 16, 2023

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 fix would be to replace :c:data:`Exception` with .. c:data:`Exception` in Doc/c-api/exceptions.rst, right?

Sorry, something went wrong.

Uh oh!

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

@serhiy-storchaka serhiy-storchaka Aug 16, 2023 •
edited
Loading

Uh oh!

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

Copy link
Copy Markdown
Member Author

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.

I tried this, and it turned out not so simple. You need to specify the type:

.. c:var:: PyObject *PyExc_SomeError

and the result does not look good.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@serhiy-storchaka
serhiy-storchaka merged commit c9d83f9 into python:main Aug 17, 2023
@miss-islington

miss-islington commented Aug 17, 2023

Copy link
Copy Markdown
Contributor

Thanks @serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖
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 core review label Aug 17, 2023
@bedevere-bot

bedevere-bot commented Aug 17, 2023

Copy link
Copy Markdown

GH-108070 is a backport of this pull request to the 3.12 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 17, 2023
@serhiy-storchaka @miss-islington
pythongh-107298: Add standard exceptions and warnings in the nitpick_…
0d0b968 
…ignore list (pythonGH-108029)

(cherry picked from commit c9d83f9)

Co-authored-by: Serhiy Storchaka <[email protected]>
@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Aug 17, 2023
@bedevere-bot

bedevere-bot commented Aug 17, 2023

Copy link
Copy Markdown

GH-108071 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 Aug 17, 2023
@serhiy-storchaka
serhiy-storchaka deleted the docs-capi-ignore-exc-refs branch August 17, 2023 06:44
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 17, 2023
@serhiy-storchaka @miss-islington
pythongh-107298: Add standard exceptions and warnings in the nitpick_…
9c51279 
…ignore list (pythonGH-108029)

(cherry picked from commit c9d83f9)

Co-authored-by: Serhiy Storchaka <[email protected]>
serhiy-storchaka added a commit that referenced this pull request Aug 17, 2023
@miss-islington @serhiy-storchaka
[3.11] gh-107298: Add standard exceptions and warnings in the nitpick…
b8e62cf 
…_ignore list (GH-108029) (GH-108071)

(cherry picked from commit c9d83f9)

Co-authored-by: Serhiy Storchaka <[email protected]>
Yhg1s pushed a commit that referenced this pull request Aug 17, 2023
@miss-islington @serhiy-storchaka
[3.12] gh-107298: Add standard exceptions and warnings in the nitpick…
125aab9 
…_ignore list (GH-108029) (#108070)

gh-107298: Add standard exceptions and warnings in the nitpick_ignore list (GH-108029)
(cherry picked from commit c9d83f9)

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

Reviewers

@vstinner vstinner vstinner left review comments
@AA-Turner AA-Turner AA-Turner approved these changes

Uh oh!

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

Assignees

No one assigned

Labels

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.

5 participants

@serhiy-storchaka @miss-islington @bedevere-bot @vstinner @AA-Turner
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.