-
Notifications
You must be signed in to change notification settings - Fork 140
Deprecate FileSystemProvider
and RenderNodeProvider
#1108
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
d-ronnqvist
merged 6 commits into
swiftlang:main
from
d-ronnqvist:deprecate-file-system-provider
Dec 4, 2024
Merged
Deprecate FileSystemProvider
and RenderNodeProvider
#1108
d-ronnqvist
merged 6 commits into
swiftlang:main
from
d-ronnqvist:deprecate-file-system-provider
Dec 4, 2024
Conversation
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
patshaughnessy
approved these changes
Dec 4, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like a great improvement 👍
Sources/SwiftDocC/Utility/FileManagerProtocol+FilesSequence.swift
Outdated
Show resolved
Hide resolved
# Conflicts: # Sources/SwiftDocCUtilities/ArgumentParsing/Subcommands/Index.swift
@swift-ci please test |
@swift-ci please test |
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.
Bug/issue #, if applicable:
Summary
This deprecates
FileSystemProvider
andRenderNodeProvider
. They each had their issues.The clearest sign that
FileSystemProvider
was a poor API is that both call sites had to reimplement tree traversal to use it:FileSystemRenderNodeProvider
implemented its own breadth first traversal to iterate over the files.StaticHostableTransformer
had ~80 LOC of private recursive functions to iterate over the files and determine what their relative paths are.The issues with
RenderNodeProvider
are more subtle. Ignoring the issues with the API naming;getProblems()
was never called, so conforming types created diagnostics that was never presented to the user.getProblems()
was unexpected errors rather that user-facing diagnostics, soProblem
isn't an appropriate type for this information.RenderNodeProvider
(not even other conforming types in tests).What the
NavigatorIndex.Builder
actually needs would have been better described bysome Sequence<RenderNode>
.Dependencies
None.
Testing
Nothing in particular. This isn't a user-facing change.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/test
script and it succeeded[ ] Updated documentation if necessaryNot applicable