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.

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

gh-101100: Fix Sphinx warnings for fileno #111118

Merged
merged 2 commits into from
Oct 23, 2023

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Oct 20, 2023

Most of these references to fileno are relating to generic objects, so add ! to them. Add the full reference to :meth:`~fileinput.fileno`.

Also fix Sphinx warnings in Doc/library/bz2.rst by documenting the missing methods using their docstrings.


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

Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

Should not some of references be to io.IOBase.fileno?

@hugovk
Copy link
Member Author

hugovk commented Oct 23, 2023

Good idea, updated!

Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

I once thought about fixing all wild references to file methods, but shelved the idea. If you're going to do it, it's best to do it in one PR rather than opening a PR for every method. Then you will be sure that they are unified.

But this PR LGTM.

@hugovk hugovk merged commit 96cbd1e into python:main Oct 23, 2023
24 checks passed
@hugovk hugovk deleted the docs-fix-sphinx-fileno branch October 23, 2023 19:05
@miss-islington-app
Copy link

Thanks @hugovk for the PR 🌮🎉.. 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 Oct 23, 2023
(cherry picked from commit 96cbd1e)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 23, 2023
(cherry picked from commit 96cbd1e)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Oct 23, 2023

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Oct 23, 2023
@bedevere-app
Copy link

bedevere-app bot commented Oct 23, 2023

GH-111227 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 Oct 23, 2023
hugovk added a commit that referenced this pull request Oct 23, 2023
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Oct 23, 2023
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants