Add visible warning about subdirs #533
Open
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.
In CompatHelper PR's, I have often had the case where
Project.tomltest/Project.tomlbecauseCompatHelper.main()does not includesubdirs = ["", "test", "docs"]This PR tries to correct course by making it more explicit that
subdirsis among the most important options to customize in a realistic package. It is important because CompatHelper itself doesn't have atest/Project.tomland so we cannot directly demonstrate that inside itsCompatHelper.ymlfile (although we could add docs).Related:
docs/Project.tomlandtest/Project.tomlas well #454