feat: Provide better Boolean help messages #2761
Merged
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.
Description
Provide meaningful information to help users trouble-shoot any problems with Boolean filters.
Note: more improvements are coming so I am not updating the documentation yet.
(This replaces #2760 which was created before I pushed some changes to
main
)Motivation and Context
Try to provide a 'help' message rather than 'error' message.
Based on: https://twitter.com/travis_simon/status/1069074730211135488
How has this been tested?
Screenshots (if appropriate)
Before:
After:
Types of changes
Changes visible to users:
feat
- non-breaking change which adds functionality)docs
- improvements to any documentation content for users)Internal changes:
test
- additions and improvements to unit tests and the smoke tests)Checklist
yarn run lint
.Terms