gh-151950: Fix Sphinx reference warnings in wsgiref docs#154498
Open
sach98 wants to merge 1 commit into
Open
Conversation
sach98
requested review from
AA-Turner,
StanFromIreland and
hugovk
as code owners
July 22, 2026 17:40
Documentation build overview
|
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.
Fixes the 18 nit-picky Sphinx reference warnings in
Doc/library/wsgiref.rstand removes the file fromDoc/tools/.nitignore.Where a correct target already exists, the reference is qualified so it resolves:
readandclosebecome:meth:`~io.BufferedIOBase.read``` and:meth:~io.IOBase.close```. This matches the existing ``:meth:~io.BufferedIOBase.write``` reference further down the same file.shift_path_infoandguess_schemeare documented inwsgiref.utilbut were referenced from a different module context, so they are now qualified.serve_foreverandhandle_requestpoint atsocketserver.BaseServer, which is whereWSGIServeractually inherits them from.The remaining names have no documented target anywhere:
Headers.keys,Headers.values,Headers.items,WSGIServer.base_environ,BaseHandler.environandSimpleHandler.stdin/stdout/stderrare described only in prose, andpaste.lintis third party. Those use the!prefix, which keeps the semantic markup and drops the link.I kept this to reference fixes so the diff stays limited to removing the warnings. If you would prefer the undocumented
Headersmethods and handler attributes to become proper.. method::and.. attribute::entries instead (as was done for the lzma constants in gh-151949), I am happy to do that here or in a follow-up.Verified with a fresh nit-picky build: warnings for this file go from 18 to 0, total build warnings go from 1352 to 1334, no new warnings elsewhere, and
Doc/tools/check-warnings.py --fail-if-regression --fail-if-improvedexits 0.Doc/library/files #151950