Fix errors in ShouldProcess rule document #1766
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bergmeister
approved these changes
Jan 28, 2022
There was a problem hiding this comment.
Awesome, thank you for the effort and very detailed description 🥳
@sdwheeler I am happy from a technical perspective, do you want to review the docs change as well before merging?
sdwheeler
reviewed
Jan 28, 2022
sdwheeler
requested changes
Jan 28, 2022
Updated as suggested. Would you review it again and resolve the request? I cannot find any way to resolve this thread by myself. |
|
@sdwheeler Can you re-review please? You can contact @JamesWTruher to get it merged as the left-over check doesn't seem to go away when pulling in master. |
sdwheeler
approved these changes
Mar 29, 2022
bergmeister
reviewed
Mar 29, 2022
bergmeister
approved these changes
Mar 29, 2022
|
Thanks @sdwheeler, can you resolve the merge conflict please and then we are good to merge 💪🏻 |
bergmeister
approved these changes
Mar 29, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.