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: Fix Sphinx warnings inc-api/float.rst#113494

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

Conversation

hugovk
Copy link
Member

@hugovkhugovk commentedDec 26, 2023•
edited by github-actionsbot
Loading

Fix these warnings by documenting the constant:

Doc/c-api/float.rst:109: WARNING: c:macro reference target not found: PY_BIG_ENDIANDoc/c-api/float.rst:140: WARNING: c:macro reference target not found: PY_BIG_ENDIAN

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

Copy link
Member

@serhiy-storchakaserhiy-storchaka left a comment

Choose a reason for hiding this comment

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

If you document PY_BIG_ENDIAN, you should also document PY_LITTLE_ENDIAN.

And I think that float.rst is a wrong place for this. They have little relation to floats. Actually, the endianess of floating point representation can be different from the endianess of integer representation (see DOUBLE_IS_BIG_ENDIAN_IEEE754, DOUBLE_IS_LITTLE_ENDIAN_IEEE754 and DOUBLE_IS_ARM_MIXED_ENDIAN_IEEE754).

@hugovk
Copy link
MemberAuthor

Good point, these constants are defined inpyport.h, nothing to do with floats.

What do you recommend?

  • Document the constants elsewhere - where?
  • Silence these warnings with!
  • Keep the warnings

@serhiy-storchaka
Copy link
Member

I do not know what is the best place for them, this is why they are still not documented. I suggest to leave this as is, until we found good place (many other macros are not documented).

@hugovk
Copy link
MemberAuthor

Fine by me, let's tackle these later. Thanks for the review!

@hugovkhugovk closed thisDec 27, 2023
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@serhiy-storchakaserhiy-storchakaserhiy-storchaka left review comments

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

Successfully merging this pull request may close these issues.

2 participants
@hugovk@serhiy-storchaka
[8]ページ先頭
©2009-2025 Movatter.jp