Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide examples for how to use rule parameters #504

Closed
SebastianZ opened this issue Dec 27, 2017 · 3 comments
Closed

Provide examples for how to use rule parameters #504

SebastianZ opened this issue Dec 27, 2017 · 3 comments

Comments

@SebastianZ
Copy link

As far as I can see, there is currently no clear description on how to configure rules using different parameters. I've also asked how to do that on Stack Overflow.

It would be great if some example(s) could be included in the README.md or a separate file.

Sebastian

@ryaneberly
Copy link
Contributor

Thanks @SebastianZ . There is some documentation in the new README
https://github.com/cflint/CFLint/tree/dev

@SebastianZ
Copy link
Author

Thank you for the quick reply here and on Stack Overflow, @ryaneberly! That already helps a lot!

This may be improved by some more examples in the future and cross linking to the built-in rule set, but that's already good enough for me, so I'll close this issue.

Sebastian

@TheRealAgentK
Copy link
Collaborator

@SebastianZ - it'd be great if you could contribute a few more examples from your end and how you're actually using it in practice.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants