Skip to content

Updates to present docs on _NIOFileSystem#3477

Merged
Lukasa merged 2 commits intomainfrom
fix-docs
Jan 13, 2026
Merged

Updates to present docs on _NIOFileSystem#3477
Lukasa merged 2 commits intomainfrom
fix-docs

Conversation

@heckj
Copy link
Copy Markdown
Contributor

@heckj heckj commented Jan 12, 2026

This re-enables documentation lost during refactoring work, under the target _NIOFileSystem

resolves #3474

Motivation:

During the refactoring of NIOFileSystem and recent Swift updates, the mechanism to "shadow" symbols using @_exported import has stopped working for documentation and imports for symbols, which means that _NIOFileSystem is the target that needs to host the documentation for this (for now)

Modifications:

Moves DocC catalog into _NIOFileSystem target, and updates disambiguation hashes on overloaded symbols in order to verify no warnings are presented while generating documentation.
Updates .spi.yml to present _NIOFileSystem instead of NIOFileSystem

Result:

Previous documentation should be available again, although at a slightly different URI structure within Swift Package Index.

@heckj heckj self-assigned this Jan 12, 2026
@heckj heckj added the semver/none No version bump required. label Jan 12, 2026
@heckj heckj requested review from Lukasa and glbrntt January 12, 2026 22:47
@Lukasa Lukasa enabled auto-merge (squash) January 13, 2026 14:00
@Lukasa Lukasa merged commit 6b33489 into main Jan 13, 2026
55 checks passed
@Lukasa Lukasa deleted the fix-docs branch January 13, 2026 14:22
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.

Documentation for NIOFileSystem can not be viewed

2 participants