Document FileStore space properties - #459
Open
jonathanpeppers wants to merge 1 commit into
Open
Conversation
Refs #210 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
jonathanpeppers
requested review from
dalexsoto
and
a lite review from Copilot
August 14, 2026 15:47
jonathanpeppers
enabled auto-merge (squash)
August 14, 2026 15:48
There was a problem hiding this comment.
Pull request overview
This PR improves the generated XML documentation for Java.Nio.FileNio.FileStore by replacing “To be added.” placeholders with meaningful descriptions for storage capacity/availability properties, aligning the docs with the referenced Android/Java documentation.
Changes:
- Documented
IsReadOnlywith clearer semantics and an Android reference link. - Documented
TotalSpace,UnallocatedSpace, andUsableSpace(includinglong.MaxValueoverflow behavior) with Android reference links. - Added additional remarks for the “hint, not a guarantee” semantics on space-related properties.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Member
Author
|
@dalexsoto review |
dalexsoto
requested changes
Aug 15, 2026
dalexsoto
left a comment
Member
There was a problem hiding this comment.
The three documented space properties omit part of their public failure contract:
docs/xml/Java.Nio.FileNio/FileStore.xml:TotalSpace,UnallocatedSpace, andUsableSpacecan each throwJava.IO.IOException, but none of the property docs include that exception. Please add the exception documentation to all three properties so callers are not told an incomplete contract.
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.
Refs #210
Documents source-backed
Java.Nio.FileNio.FileStoreavailability and capacity properties:IsReadOnly,TotalSpace,UnallocatedSpace, andUsableSpace.Sources
Validation
docs/xml/Java.Nio.FileNio/FileStore.xmlwithSystem.Xml.XmlDocument.git diff --check.FileStore.xmlplaceholders changed from 17 to 9.