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 — Fix Sphinx warnings in C API doc by vstinner · Pull Request #107274 · python/cpython

Conversation

@vstinner

@vstinner vstinner commented Jul 25, 2023 •
edited by github-actions Bot
Loading

Uh oh!

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

Copy link
Copy Markdown
Member

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@vstinner
Fix Sphinx warnings in C API doc
6c3feb7
@vstinner vstinner added the skip news label Jul 25, 2023
@bedevere-bot bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Jul 25, 2023
@vstinner vstinner added the skip issue label Jul 25, 2023
@vstinner
vstinner marked this pull request as draft July 26, 2023 00:16
@bedevere-bot bedevere-bot removed the awaiting core review label Jul 26, 2023
@vstinner

vstinner commented Jul 26, 2023

Copy link
Copy Markdown
Member Author

Hum. I already created PR #107164 but this one is supposed to be more complete. But then I fixed more and more warnings in a local branch, and quickly I went to too many directions. Now I'm confused and I'm not sure how to split this work.

So instead I created PR #107278 to first fix warnings like c:identifier reference target not found: va_list.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
serhiy-storchaka
serhiy-storchaka reviewed Jul 26, 2023
View reviewed changes
Comment thread Doc/c-api/bool.rst
.. c:function:: int PyBool_Check(PyObject *o)

Return true if *o* is of type :c:data:`PyBool_Type`. This function always
Return true if *o* is of type :c:data:`!PyBool_Type`. This function always

@serhiy-storchaka serhiy-storchaka Jul 26, 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.

Would not be better to add the documentation for PyBool_Type?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/c-api/apiabiversion.rst
Use this for numeric comparisons, e.g. ``#if PY_VERSION_HEX >= ...``.

This version is also available via the symbol :data:`Py_Version`.
This version is also available via the symbol :c:var:`Py_Version`.

@serhiy-storchaka serhiy-storchaka Jul 26, 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.

See #107091. It is discussed whether we should use :c:var: or :c:data:.

#107063 also fixes this line.

Sorry, something went wrong.

Uh oh!

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

vstinner commented Jul 26, 2023

Copy link
Copy Markdown
Member Author

I reworked this change into a serie of changes: I created issue #107298. I abandon this PR.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@vstinner vstinner closed this Jul 26, 2023
@vstinner
vstinner deleted the fix_doc branch July 26, 2023 17:04
@vstinner vstinner mentioned this pull request Jul 26, 2023
Fix Sphinx warnings in the C API documentation #107298
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@serhiy-storchaka serhiy-storchaka serhiy-storchaka left review comments
@ZeroIntensity ZeroIntensity Awaiting requested review from ZeroIntensity ZeroIntensity will be requested when the pull request is marked ready for review ZeroIntensity is a code owner

Uh oh!

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

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip issue 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.

3 participants

@vstinner @serhiy-storchaka @bedevere-bot
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.