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.

Sign up for GitHub

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

Jump to bottom

Fix Sphinx warnings in C API doc #107274

Closed
wants to merge 1 commit into from
Closed

Fix Sphinx warnings in C API doc #107274

wants to merge 1 commit into from

Conversation

vstinner
Copy link
Member

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

@bedevere-bot bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Jul 25, 2023
@vstinner vstinner marked this pull request as draft July 26, 2023 00:16
@vstinner
Copy link
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.

serhiy-storchaka
serhiy-storchaka reviewed Jul 26, 2023
View reviewed changes
Doc/c-api/bool.rst
@@ -13,7 +13,7 @@ are available, however.

.. 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
Copy link
Member

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?

Doc/c-api/apiabiversion.rst
@@ -60,7 +60,7 @@ See :ref:`stable` for a discussion of API and ABI stability across versions.

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`.
Copy link
Member

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.

@vstinner
Copy link
Member Author

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

@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
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

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