gh-101100: Resolve some os sphinx reference warnings#139636
Merged
Merged
Conversation
Point to either the constants in `stat` or to `os.stat_result` as needed.
Reference `dict` as os.environ emulates that and `collections.abc.MutableMapping` doesn't have members defined.
Change to similar sample code used in `free-threading-python.rst`
kumaraditya303
approved these changes
Oct 8, 2025
vstinner
reviewed
Oct 8, 2025
Co-authored-by: Victor Stinner <vstinner@python.org>
|
Thanks @cmaloney for the PR, and @kumaraditya303 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14. |
|
GH-151765 is a backport of this pull request to the 3.14 branch. |
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
3 participants
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.
Individual commits have more details around each case.
This + GH-139592 get
osdown to two reference warning sources:os.statvfs()pieces which need docs written for both the return object attributes (f_bsize, ...) as well asosconstants (ST_RDONLY, ...)os.uname()pieces which need docs written for the return object attributes (sysname,nodename, ...)Planning to work on those to get
osreference warnings clean once learn from these two PRs📚 Documentation preview 📚: https://cpython-previews--139636.org.readthedocs.build/