Repository navigation
gh-151950: Fix Sphinx reference warnings in termios docs - #153885
Merged
Merged
Conversation
Document the VMIN/VTIME, TCIFLUSH/TCOFLUSH/TCIOFLUSH, TCOOFF/TCOON/TCIOFF/TCION and TIOC* window-size constants with ``.. data::`` directives so the ``:const:`` references resolve, and drop termios.rst from Doc/tools/.nitignore.
harjothkhara
requested review from
AA-Turner,
StanFromIreland and
hugovk
as code owners
July 18, 2026 05:25
Documentation build overview
432 files changed ·
|
Contributor
Author
|
termios.rst part of #151950, docs only and CI is green, could someone take a look? |
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
asvetlov
approved these changes
Oct 28, 2026
Contributor
|
Thanks, @harjothkhara! |
hugovk
added
needs backport to 3.14
|
Thanks @harjothkhara for the PR, and @asvetlov for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14. |
|
Thanks @harjothkhara for the PR, and @asvetlov for merging it 🌮🎉.. I'm working now to backport this PR to: 3.15. |
|
GH-160818 is a backport of this pull request to the 3.14 branch. |
|
GH-160819 is a backport of this pull request to the 3.15 branch. |
hugovk
pushed a commit
that referenced
this pull request
Oct 28, 2026
hugovk
pushed a commit
that referenced
this pull request
Oct 28, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This covers the
termios.rstfile from gh-151950 (part of theSphinx-warnings meta issue gh-151940); other files there are handled by
separate per-file PRs.
Fixes the Sphinx nit-picky reference warnings for
Doc/library/termios.rstand removes the file fromDoc/tools/.nitignoreso future regressions are caught by CI... data::directives, following the existing
TCSANOW/TCSADRAIN/TCSAFLUSHpattern in the same file: the
VMIN/VTIMEccindices, theTCIFLUSH/TCOFLUSH/TCIOFLUSHflush selectors, theTCOOFF/TCOON/TCIOFF/TCIONflow actions, and theTIOCGWINSZ/TIOCSWINSZ/TIOCGSIZE/TIOCSSIZEwindow-size requests.TIOC*entries note they are not defined on all platforms, sincetcgetwinsize/tcsetwinsizeonly require one of each pair.Verified with a full nit-picky build: the file emits no warnings and
Doc/tools/check-warnings.py --fail-if-regression --fail-if-improvedpasses. Documentation-only reference fix, so no NEWS entry (skip news).
Doc/library/files #151950