gh-101100: Fix os.statvfs and os.uname references#151301
Open
cmaloney wants to merge 7 commits into
Open
Conversation
Restructure descriptive paragraphs to class definitions copying across descriptions. Add constants from statvfs to os as data directives. Expand the `os.uname` section slightly with a see also which matches the one at the beginning of os.rst added in pythongh-56535 (commit a83cdaa). --- The statvfs_result members had no definition before and I opted not to add ones ere. The C code in `posixmodule.c` just forwards them directly so I don't think a description would be more precise than what is in the man page.
cmaloney
requested review from
AA-Turner,
StanFromIreland and
hugovk
as code owners
bedevere-app
Bot
added
awaiting review
docs
Documentation build overview
23 files changed ·
|
Comment on lines
+803
to
+804
| The return value is a :class:`uname_result` object whose attributes | ||
| correspond to the members described in :manpage:`uname(2)`. |
Member
There was a problem hiding this comment.
Suggested change
| The return value is a :class:`uname_result` object whose attributes | |
| correspond to the members described in :manpage:`uname(2)`. | |
| The return value is a :class:`uname_result` object. |
I think the note should be with the attributes ("These attributes correspond to the ...").
Contributor
Author
There was a problem hiding this comment.
Misinterpreted this my first read, moved the manpage reference to the uname_result section
Co-authored-by: Stan Ulbrych <stan@python.org>
| For backwards compatibility, this object is also iterable, behaving | ||
| like a five-tuple containing :attr:`sysname`, :attr:`nodename`, | ||
| :attr:`release`, :attr:`version`, and :attr:`machine` | ||
| like a five-tuple containing :attr:`~uname_result.sysname`, |
Member
There was a problem hiding this comment.
This is a repeating of what is documented for the result type, for which we already have reference. I think this can be removed.
Contributor
Author
There was a problem hiding this comment.
Moved these pieces into uname_result.
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.
Restructure descriptive paragraphs to class definitions copying across descriptions. Add constants from
statvfstoosas data directives.Expand the
os.unamesection slightly with a see also which matches the one at the beginning of os.rst added in gh-56535 commit a83cdaa.This gets
os.rstout of nitignore.The statvfs_result members had no definition before and I opted not to add ones here. The C code in
posixmodule.cjust forwards them directly so I don't think a description would be more precise than what is in the man page.