Fix AvoidUsingDoubleQuotesForConstantString information in overview README
#1883
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
As identified[^1] by @BenedekFarkas, the line in the rules overview readme for `AvoidUsingDoubleQuotesForConstantString` incorrectly lists the severity as `Warning` and that the rule is configurable when the severity is `Information`[^2] and there aren't any configurable options. This change copies the fix @BenedekFarkas kindly submitted to the docs site to ensure the documentation stays up-to-date. [^1]: For more information, see: - MicrosoftDocs/PowerShell-Docs-Modules#128 [^2]: Source code: https://github.com/PowerShell/PSScriptAnalyzer/blob/9a6ce978d870909e688d9da0d101d3fc00b504f0/Rules/AvoidUsingDoubleQuotesForConstantString.cs#L142
bergmeister
approved these changes
Feb 22, 2023
bergmeister
changed the title
AvoidUsingDoubleQuotesForConstantString information in overview READMEAvoidUsingDoubleQuotesForConstantString information in overview README
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
As identified1 by @BenedekFarkas, the line in the rules overview readme for
AvoidUsingDoubleQuotesForConstantStringincorrectly lists the severity asWarningand that the rule is configurable when the severity isInformation2 and there aren't any configurable options.This change copies the fix @BenedekFarkas kindly submitted to the docs site to ensure the documentation stays up-to-date.
PR Checklist
.cs,.ps1and.psm1files have the correct copyright headerWIP:to the beginning of the title and remove the prefix when the PR is ready.Footnotes
For more information, see:
- Documentation is outdated on the AvoidUsingDoubleQuotesForConstantString rule's Severity and Configurability MicrosoftDocs/PowerShell-Docs-Modules#128
↩Source code:
https://github.com/PowerShell/PSScriptAnalyzer/blob/9a6ce978d870909e688d9da0d101d3fc00b504f0/Rules/AvoidUsingDoubleQuotesForConstantString.cs#L142 ↩