Add ability to specify which files should be included and excluded when documenting a module. #699
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.
This change allows us to pass in a list of files to explicitly include and explicitly exclude from the doc command. This can dramatically improve parsing performance for large projects where we only need to document a subset of the files.
This change is specifically targeted at jazzy's use case and is meant to mirror the behavior of the
include
andexclude
flags from that package. Currently the entire module is parsed even if jazzy is giveninclude
andexclude
flags. With this change jazzy should be able to forward these flags tosourcekitten
In our case this change was able to reduce the parsing time by 80% when generating docs, going from 15 minutes to 3 minutes.