Skip to content

Add suggestion to read About_TOPIC files to Script Analyzer rules #575

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

Open
kilasuit opened this issue Jun 23, 2016 · 2 comments
Open

Add suggestion to read About_TOPIC files to Script Analyzer rules #575

kilasuit opened this issue Jun 23, 2016 · 2 comments

Comments

@kilasuit
Copy link
Contributor

When you have a Rule run for example the PSUseOutputTypeCorrectly I would suggest adding in information to the rule Output to the user to check any possible corresponding About_help Topic for information on how to mitigate the rule being flagged.

@juneb - What do you think to this idea?

@kapilmb
Copy link

kapilmb commented Jul 18, 2016

We have rule documentation which gives information on how to fix a particular violation. Would providing a pointer to the corresponding doc file in the rule violation output message be something that would work?

@kilasuit
Copy link
Contributor Author

@kapilmb - Yes it would however I would also think that it would be more intuitive in the Rule Description to include a suggestion to read the about_topic that corresponds to that particular rule (if there is one of course)

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

3 participants