◐ Shell
reader mode source ↗
Skip to content

gh-101100: Fix sphinx warnings in c-api/file.rst#114546

Merged
hugovk merged 3 commits into
python:mainfrom
sobolevn:issue-101100-capi-file
Jan 26, 2024
Merged

gh-101100: Fix sphinx warnings in c-api/file.rst#114546
hugovk merged 3 commits into
python:mainfrom
sobolevn:issue-101100-capi-file

Conversation

@sobolevn

@sobolevn sobolevn commented Jan 25, 2024 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

It used to be:

/Users/sobolev/Desktop/cpython2/Doc/c-api/file.rst:63: WARNING: c:identifier reference target not found: Py_OpenCodeHookFunction
/Users/sobolev/Desktop/cpython2/Doc/c-api/file.rst:95: WARNING: c:macro reference target not found: Py_PRINT_RAW

I've added docs about two public things:

  • Py_PRINT_RAW macro
  • Py_OpenCodeHookFunction typedef

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

@sobolevn sobolevn requested review from AA-Turner and hugovk January 25, 2024 07:29
@bedevere-app bedevere-app Bot added awaiting review docs Documentation in the Doc dir skip news labels Jan 25, 2024
@bedevere-app bedevere-app Bot mentioned this pull request Jan 25, 2024
Open
@sobolevn sobolevn force-pushed the issue-101100-capi-file branch from af83cde to 46e1fa6 Compare January 25, 2024 07:30
@sobolevn sobolevn added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Jan 25, 2024
@sobolevn

sobolevn commented Jan 25, 2024

Copy link
Copy Markdown
Member Author

Turns out I've also fixed object.rst 🎉

@sobolevn @hugovk
Apply suggestions from code review …
0530890 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
hugovk
hugovk approved these changes Jan 26, 2024
View reviewed changes

@hugovk hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hide comment

Thank you!

@hugovk hugovk merged commit 01d970c into python:main Jan 26, 2024
@miss-islington-app

miss-islington-app Bot commented Jan 26, 2024

Copy link
Copy Markdown

Thanks @sobolevn for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 26, 2024
@sobolevn @hugovk @miss-islington
pythongh-101100: Fix sphinx warnings in c-api/file.rst (pythonGH-11… …
b22c556 
…4546)

(cherry picked from commit 01d970c)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 26, 2024
@sobolevn @hugovk @miss-islington
pythongh-101100: Fix sphinx warnings in c-api/file.rst (pythonGH-11… …
50ee15a 
…4546)

(cherry picked from commit 01d970c)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@bedevere-app

bedevere-app Bot commented Jan 26, 2024

Copy link
Copy Markdown

GH-114584 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label Jan 26, 2024
@bedevere-app

bedevere-app Bot commented Jan 26, 2024

Copy link
Copy Markdown

GH-114585 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.11 only security fixes label Jan 26, 2024
hugovk added a commit that referenced this pull request Jan 26, 2024
@miss-islington @sobolevn @hugovk
[3.11] gh-101100: Fix sphinx warnings in c-api/file.rst (GH-114546) (… …
170bf79 
…#114585)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@serhiy-storchaka

serhiy-storchaka commented Jan 26, 2024

Copy link
Copy Markdown
Member

It creates incorrect references and index entries.

@hugovk

hugovk commented Jan 26, 2024

Copy link
Copy Markdown
Member

Which ones are wrong?

@serhiy-storchaka

serhiy-storchaka commented Jan 26, 2024

Copy link
Copy Markdown
Member

The newly documented names. They are added in wrong namespaces.

@sobolevn

sobolevn commented Jan 26, 2024

Copy link
Copy Markdown
Member Author

New references:

I think that the first one is indeed in correct. It should be: https://cpython-previews--114546.org.readthedocs.build/en/114546/c-api/file.html#c.Py_OpenCodeHookFunction

Снимок экрана 2024-01-26 в 18 48 18

Yes, this would be more correct! Thank you

@sobolevn sobolevn mentioned this pull request Jan 26, 2024
Merged
hugovk added a commit that referenced this pull request Feb 4, 2024
@miss-islington @sobolevn @hugovk
[3.12] gh-101100: Fix sphinx warnings in c-api/file.rst (GH-114546) (… …
cf2ecbc 
…#114584)

* gh-101100: Fix sphinx warnings in `c-api/file.rst` (GH-114546)
(cherry picked from commit 01d970c)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@sobolevn @hugovk @aisk
pythongh-101100: Fix sphinx warnings in c-api/file.rst (python#114546) …
6b02638 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@sobolevn @hugovk @Glyphack
pythongh-101100: Fix sphinx warnings in c-api/file.rst (python#114546) …
4c4f09b 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovk hugovk hugovk approved these changes

@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@sobolevn @serhiy-storchaka @hugovk