Clarify exclude/include behavior in README #2193
Merged
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
devoncarew
approved these changes
Apr 24, 2020
srawlins
approved these changes
Apr 24, 2020
README.md
Outdated
| @@ -120,18 +120,23 @@ dartdoc: | |||
| - tool-error | |||
| ``` | |||
|
|
|||
| #### dartdoc_options.yaml fields | |||
|
|
|||
| In general, **paths are relative** to the directory the `dartdoc_options.yaml` the option is defined in | |||
There was a problem hiding this comment.
The grammar here is hard to parse. Maybe
In general, paths are relative to the directory of the
dartdoc_options.yamlfile in which the option is defined, and should be specified as POSIX paths.
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.
Fixes #2155.
Probably not P1 anymore since the underlying issue causing people to try to use the exclude parameter in this way is fixed, but this PR updates the README to hopefully eliminate remaining confusion.