Skip to content

Clarify state and relationship of NIOFileSystem and _NIOFileSystem in API docs#3504

Merged
simonjbeaumont merged 3 commits intoapple:mainfrom
simonjbeaumont:sb/niofs-docs
Feb 6, 2026
Merged

Clarify state and relationship of NIOFileSystem and _NIOFileSystem in API docs#3504
simonjbeaumont merged 3 commits intoapple:mainfrom
simonjbeaumont:sb/niofs-docs

Conversation

@simonjbeaumont
Copy link
Copy Markdown
Contributor

Motivation:

NIOFileSystem currently exposes the same API as _NIOFileSystem, which is not API stable. NIOFileSystem
was created in error, and its lack of underscore incorrectly implies API stability. Users who are currently importing NIOFileSystem should ideally move to _NIOFileSystem. However this isn't made clear in the docs:

  1. The README talks about the non-underscored NIOFileSystem.
  2. There are no hosted API docs NIOFileSystem.
  3. The hosted API docs for NIO point to the docs for NIOFileSystem -- results in 404.

Modifications:

  • Update the README to refer to _NIOFileSystem.
  • Update the hosted API docs for NIO to point to docs for _NIOFileSystem.
  • Add hosted API docs for NIOFileSystem with a statement explaining the situation and pointing people to the docs
    for _NIOFileSystem.

Result:

Clearer documentation on the state and relationship of the NIOFileSystem and _NIOFileSystem modules.

@simonjbeaumont simonjbeaumont added the semver/none No version bump required. label Feb 6, 2026
@simonjbeaumont simonjbeaumont enabled auto-merge (squash) February 6, 2026 18:35
@simonjbeaumont simonjbeaumont merged commit edad6d8 into apple:main Feb 6, 2026
55 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

semver/none No version bump required.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants