Fix errors in ShouldProcess rule document - #1766
Conversation
Christoph Bergmeister (bergmeister)
left a comment
There was a problem hiding this comment.
Awesome, thank you for the effort and very detailed description 🥳
Sean Wheeler (@sdwheeler) I am happy from a technical perspective, do you want to review the docs change as well before merging?
Sean Wheeler (sdwheeler)
left a comment
There was a problem hiding this comment.
One minor change to link to about_* topics.
Updated as suggested. Would you review it again and resolve the request? I cannot find any way to resolve this thread by myself. |
|
Sean Wheeler (@sdwheeler) Can you re-review please? You can contact James Truher (@JamesWTruher) to get it merged as the left-over check doesn't seem to go away when pulling in master. |
|
Thanks Sean Wheeler (@sdwheeler), can you resolve the merge conflict please and then we are good to merge 💪🏻 |
PR Summary
Write-Hostfrom the correct example. It is duplicated with outputs of-WhatIfor-Confirm. It also violates "Avoid Using Write-Host" rule.ShouldProcessrule as mentioned inShouldProcess.md.Get-ScriptAnalyzerRule -Name PSShouldProcess | % Severityalso returns "Warning" with ScriptAnalyzer 1.20.0PR Checklist
Make sure all.cs,.ps1and.psm1files have the correct copyright headerMake sure you've added a new test if existing tests do not effectively test the code changed and/or updated documentationWIP:to the beginning of the title and remove the prefix when the PR is ready.Script Analyzer 1.20.0 detects aFor some reason, Script Analyzer 1.20.0 doesn't detect anyShouldProcessviolation in the updated wrong example.ShouldProcessviolation in the updated wrong example.