FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-101100: Fix Sphinx warnings for `fileno` by hugovk · Pull Request #111118 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-101100: Fix Sphinx warnings for fileno - #111118

Merged
hugovk merged 2 commits into
python:mainfrom
hugovk:docs-fix-sphinx-fileno
Oct 23, 2023
ConversationCommits (2)ChecksFiles changed
Merged

gh-101100: Fix Sphinx warnings for fileno#111118
hugovk merged 2 commits into
python:mainfrom
hugovk:docs-fix-sphinx-fileno

Conversation

hugovk commented Oct 20, 2023 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

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/

hugovk added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes and removed awaiting core review labels Oct 20, 2023
bedevere-app Bot mentioned this pull request Oct 20, 2023
Closed
serhiy-storchaka reviewed Oct 21, 2023
View reviewed changes

serhiy-storchaka 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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

hugovk commented Oct 23, 2023

Copy link
Copy Markdown
Member Author

Good idea, updated!

serhiy-storchaka approved these changes Oct 23, 2023
View reviewed changes

serhiy-storchaka 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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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 merged commit 96cbd1e into python:main Oct 23, 2023
hugovk deleted the docs-fix-sphinx-fileno branch October 23, 2023 19:05

miss-islington-app Bot commented Oct 23, 2023

Copy link
Copy Markdown

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
pythongh-101100: Fix Sphinx warnings for fileno (pythonGH-111118)
0a58013 
(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
pythongh-101100: Fix Sphinx warnings for fileno (pythonGH-111118)
3441fde 
(cherry picked from commit 96cbd1e)

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

bedevere-app Bot commented Oct 23, 2023

Copy link
Copy Markdown

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

bedevere-app Bot removed the needs backport to 3.12 only security fixes label Oct 23, 2023

bedevere-app Bot commented Oct 23, 2023

Copy link
Copy Markdown

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

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
[3.11] gh-101100: Fix Sphinx warnings for fileno (GH-111118) (#111227)
bf41dcd 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Oct 23, 2023
[3.12] gh-101100: Fix Sphinx warnings for fileno (GH-111118) (#111226)
38578dd 
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
pythongh-101100: Fix Sphinx warnings for fileno (python#111118)
1240ee3
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
pythongh-101100: Fix Sphinx warnings for fileno (python#111118)
d3624de
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

serhiy-storchaka serhiy-storchaka approved these changes

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL