This repository was archived by the owner on Jun 1, 2023. It is now read-only.
Display a warning if an input directory does not exist.#242
Merged
mattt merged 4 commits intoSwiftDocOrg:masterfrom Apr 17, 2021
Merged
Display a warning if an input directory does not exist.#242mattt merged 4 commits intoSwiftDocOrg:masterfrom
mattt merged 4 commits intoSwiftDocOrg:masterfrom
Conversation
mattt
approved these changes
Apr 17, 2021
Contributor
mattt
left a comment
There was a problem hiding this comment.
This is an excellent and thoughtful change. Great work, @Lukas-Stuehrk! Merging this in now.
mattt
reviewed
Apr 17, 2021
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
A small improvement, so users can troubleshoot problems easier.
Before, when you accidentally misspelled the input path or provided for any other reason a path to directory which does not exist, swift-doc only displayed a warning that no symbols where found. This could lead new users into a very wrong direction.
With this change, there's an additional warning that the given directory does not exist. If an input path exists but is not a directory, a helpful warning is displayed as well, as swift-doc only works with paths to directories and not direct paths to Swift source files.