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

Documentation generator doesn't handle settings property in assertion file #276

Closed
pnevyk opened this issue Sep 29, 2017 · 3 comments
Closed

Comments

@pnevyk
Copy link
Contributor

pnevyk commented Sep 29, 2017

Some rules use settings property in their assertions definition, e.g. to show that the rule is not applied when onlyFilesWithFlowAnnotation setting option is set to true and there is no such annotation in the code. However, documentation generator doesn't handle this property at all, so in docs there is wrong use case of the rule which is considered not a problem, without any note about onlyFilesWithFlowAnnotation setting.

@gajus
Copy link
Owner

gajus commented Sep 29, 2017

Easy PR.

@gajus
Copy link
Owner

gajus commented Sep 29, 2017

Thank you @pnevyk

@pnevyk
Copy link
Contributor Author

pnevyk commented Sep 29, 2017

@gajus I am glad I could help :)

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

No branches or pull requests

2 participants