GeezerVison

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

GeezerVison is showing github.com — Fix Sphinx warnings on unknown targets by vstinner · Pull Request #107164 · python/cpython

Conversation

vstinner commented Jul 23, 2023 •

edited by github-actions Bot

Loading

Uh oh!

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

Copy link

Copy Markdown

Member

Fix warnings like:

py:data reference target not found: Py_Version
c:func reference target not found: malloc

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

Sorry, something went wrong.

Uh oh!

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

All reactions


          Fix Sphinx warnings on unknown targets

0e95ba5

Fix warnings like:

* py:data reference target not found: Py_Version
* c:func reference target not found: malloc

bedevere-bot added awaiting core review docs

Documentation in the Doc dir

skip news labels

Jul 23, 2023

vstinner added the skip issue label

Jul 23, 2023

erlend-aasland commented Jul 23, 2023

Copy link

Copy Markdown

Contributor

Uh oh!

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

erlend-aasland commented Jul 23, 2023

Copy link

Copy Markdown

Contributor

... and gh-107062

All reactions

Sorry, something went wrong.

Uh oh!

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

vstinner commented Jul 23, 2023

Copy link

Copy Markdown

Member Author

Docs / Docs job failed with:

Warning: c:identifier reference target not found: va_list
Warning: c:identifier reference target not found: va_list
Warning: 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.

erlend-aasland commented Jul 23, 2023

Copy link

Copy Markdown

Contributor

Docs / Docs job failed with:

Warning: c:identifier reference target not found: va_list
Warning: c:identifier reference target not found: va_list
Warning: c:identifier reference target not found: va_list

No, you misread the CI information. This is what you need to fix ;)

Congratulations! You improved:

Doc/c-api/apiabiversion.rst

Please remove from Doc/tools/.nitignore

All reactions

Sorry, something went wrong.

Uh oh!

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

erlend-aasland reviewed

Jul 23, 2023

View reviewed changes

Comment thread

Doc/c-api/arg.rst

		for the ``s`` and ``s#`` formats, the required data is copied. Buffers provided
		by the caller are never referenced by the objects created by
		:c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`malloc`
		:c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`!malloc`

erlend-aasland Jul 23, 2023

Copy link

Copy Markdown

Contributor

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.

This is not needed; malloc is in the nitignore list in Doc/conf.py.

Suggested change

	:c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`!malloc`
	:c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`malloc`

Sorry, something went wrong.

Uh oh!

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

All reactions

vstinner Jul 24, 2023

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 saw warnings on this function on this documentation page. Maybe the PR was outdated, I don't recall the details.

I didn't know nitignore, that sounds very useful!

Sorry, something went wrong.

Uh oh!

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

All reactions

erlend-aasland reviewed

Jul 23, 2023

View reviewed changes

Comment thread

Doc/c-api/arg.rst

		:c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`!malloc`
		and passes the allocated memory to :c:func:`Py_BuildValue`, your code is
		responsible for calling :c:func:`free` for that memory once
		responsible for calling :c:func:`!free` for that memory once

erlend-aasland Jul 23, 2023

Copy link

Copy Markdown

Contributor

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.

Ditto. See Doc/conf.py

Suggested change

	responsible for calling :c:func:`!free` for that memory once
	responsible for calling :c:func:`free` for that memory once

Sorry, something went wrong.

Uh oh!

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

All reactions

vstinner marked this pull request as draft

July 26, 2023 00:16

bedevere-bot removed the awaiting core review label

Jul 26, 2023

vstinner mentioned this pull request

Jul 26, 2023

Fix Sphinx warnings in C API doc #107274

Closed

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 closed this

Jul 26, 2023

vstinner mentioned this pull request

Jul 26, 2023

Fix Sphinx warnings in the C API documentation #107298

Closed

Reviewers

erlend-aasland

erlend-aasland left review comments

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

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

vstinner commented Jul 23, 2023 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

erlend-aasland commented Jul 23, 2023

Uh oh!

erlend-aasland commented Jul 23, 2023

Uh oh!

vstinner commented Jul 23, 2023

Uh oh!

erlend-aasland commented Jul 23, 2023

Uh oh!

erlend-aasland Jul 23, 2023

Choose a reason for hiding this comment

Uh oh!

vstinner Jul 24, 2023

Choose a reason for hiding this comment

Uh oh!

erlend-aasland Jul 23, 2023

Choose a reason for hiding this comment

Uh oh!

vstinner commented Jul 26, 2023

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vstinner commented Jul 23, 2023 •

edited by github-actions Bot

Loading

Uh oh!

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