rule docs should include example rules
Think it would be nice to add example rules for each rule keyword. Perhaps a minimal example and a real world one from the ETOpen set.
Updated by Peter Manev about 7 years ago
It think it will also be a good idea to make that part of the PR process (as well) where such a PR introduces new or updates keywords.
Otherwise the "how to" for new or updated keywords is not visible to the rulewriters or end users.
Easier said than done I suppose - it would be ideal if we can maybe have something like -
where each listed keyword can have an example rule.
Maybe we could reuse a good part of the unittests to help out with that ?
Updated by Victor Julien over 5 years ago
- Effort set to high
- Difficulty set to low
I'm open to both. I also think it would be a nice idea to have per rule keyword manpages, based on the user docs. Like how for example git commands have their own manpages. These manpages should then have one or more example rules.