Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

gh-101100: [docs] Fix Sphinx warnings indis module#102597

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Closed
sobolevn wants to merge3 commits intopython:mainfromsobolevn:issue-101100-dis

Conversation

sobolevn
Copy link
Member

@sobolevnsobolevn commentedMar 11, 2023•
edited by bedevere-bot
Loading

Original errors:

./cpython/Doc/library/dis.rst:46: WARNING: py:func reference target not found: myfunc./cpython/Doc/library/dis.rst:51: WARNING: py:func reference target not found: myfunc./cpython/Doc/library/dis.rst:795: WARNING: py:func reference target not found: builtins.__build_class__./cpython/Doc/library/dis.rst:852: WARNING: py:attr reference target not found: co_names./cpython/Doc/library/dis.rst:859: WARNING: py:attr reference target not found: co_names./cpython/Doc/library/dis.rst:898: WARNING: py:attr reference target not found: co_names./cpython/Doc/library/dis.rst:907: WARNING: py:attr reference target not found: co_names./cpython/Doc/library/dis.rst:1426: WARNING: c:func reference target not found: PyObject_Format

A couple of notes for reviewers:

  1. :func:myfunc was rendered incorrectly (invalid signature):

    Снимок экрана 2023-03-11 в 12 02 24

    Because:func: is reserved for functions defined with.. function:: directive.

  2. I've silenced!builtins.__build_class__ reference, because as far as I understand, there's no desire in documenting this feature. So, now this reference renders the same way, but just does not error out

  3. :attr:!codeobject.* are also just ignoring warnings, because right now there's no way to address these attributes documented here:https://github.com/python/cpython/blame/5ffdaf748d98da6065158534720f1996a45a0072/Doc/reference/datamodel.rst#L956 So, we just add an ignore and slightly more context

  4. PyObject_Format will be found aftergh-102595: DocumentPyObject_Format c-api function #102596 is merged

Copy link
Member

@CAM-GerlachCAM-Gerlach left a comment•
edited
Loading

Choose a reason for hiding this comment

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

Seems otherwise good overall, but instead of disabling resolution and silencing the warnings, couldco_names be properly documented instead, just likecodeobject.co_positions currently is, especially since it's referenced nearly a dozen times in this document?

@sobolevn
Copy link
MemberAuthor

sobolevn commentedMar 11, 2023•
edited
Loading

I don't know enough about the history of these fields. They might be not documented on purpose. We need a field expert here to decide.

@sobolevn
Copy link
MemberAuthor

@iritkatriel can you please take a look? :)

@JelleZijlstraJelleZijlstra self-requested a reviewMay 7, 2023 02:07
@JelleZijlstraJelleZijlstra added the needs backport to 3.11only security fixes labelMay 7, 2023
Copy link
Member

@AA-TurnerAA-Turner left a comment

Choose a reason for hiding this comment

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

A comment on the pre-fixing ofcodeobject. -- I think we should revert this for now.

It may also be better to add an entry tonitpick_ignore inconf.py with an explanatory note rather than supressing these warnings, if we intend to document the code object attributes at a later date.

@hugovk
Copy link
Member

if we intend to document the code object attributes at a later date.

Or can we do it now?

@JelleZijlstraJelleZijlstra removed their request for reviewJune 7, 2023 00:49
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@sobolevn
Copy link
MemberAuthor

sobolevn commentedAug 25, 2023•
edited
Loading

Closed by#108476 by@erlend-aasland

@erlend-aasland
Copy link
Contributor

Sorry,@sobolevn, I didn't know you had a PR open :(

sobolevn reacted with thumbs up emoji

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@JelleZijlstraJelleZijlstraJelleZijlstra left review comments

@arhadthedevarhadthedevarhadthedev left review comments

@CAM-GerlachCAM-GerlachCAM-Gerlach left review comments

@AA-TurnerAA-TurnerAA-Turner requested changes

@Fidget-SpinnerFidget-SpinnerFidget-Spinner approved these changes

@iritkatrieliritkatrielAwaiting requested review from iritkatriel

Assignees
No one assigned
Labels
awaiting mergedocsDocumentation in the Doc dirneeds backport to 3.11only security fixesskip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

9 participants
@sobolevn@hugovk@erlend-aasland@JelleZijlstra@arhadthedev@AA-Turner@CAM-Gerlach@Fidget-Spinner@bedevere-bot
[8]ページ先頭
©2009-2025 Movatter.jp