Clarify state and relationship of NIOFileSystem and _NIOFileSystem in API docs#3504
Merged
simonjbeaumont merged 3 commits intoapple:mainfrom Feb 6, 2026
Merged
Conversation
rnro
approved these changes
Feb 6, 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.
Motivation:
NIOFileSystemcurrently exposes the same API as_NIOFileSystem, which is not API stable.NIOFileSystemwas created in error, and its lack of underscore incorrectly implies API stability. Users who are currently importing
NIOFileSystemshould ideally move to_NIOFileSystem. However this isn't made clear in the docs:NIOFileSystem.NIOFileSystem.NIOpoint to the docs forNIOFileSystem-- results in 404.Modifications:
_NIOFileSystem.NIOto point to docs for_NIOFileSystem.NIOFileSystemwith a statement explaining the situation and pointing people to the docsfor
_NIOFileSystem.Result:
Clearer documentation on the state and relationship of the
NIOFileSystemand_NIOFileSystemmodules.