Skip to content

Documentation is outdated on the AvoidUsingDoubleQuotesForConstantString rule's Severity and Configurability #128

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.

Sign up for GitHub

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

Jump to bottom
Closed
3 tasks done
BenedekFarkas opened this issue Jan 12, 2023 · 0 comments · Fixed by #129
Closed
3 tasks done

Documentation is outdated on the AvoidUsingDoubleQuotesForConstantString rule's Severity and Configurability #128

BenedekFarkas opened this issue Jan 12, 2023 · 0 comments · Fixed by #129
Labels
issue-doc-bug Issue - error in documentation needs-triage Waiting - Needs triage

Comments

@BenedekFarkas
Copy link
Contributor

BenedekFarkas commented Jan 12, 2023 •
edited
Loading

Prerequisites

  • Existing Issue: Search the existing issues for this repository. If there is an issue that fits your needs do not file a new one. Subscribe, react, or comment on that issue instead.
  • Descriptive Title: Write the title for this issue as a short synopsis. If possible, provide context. For example, "Typo in Get-Foo cmdlet" instead of "Typo."
  • Verify Version: If there is a mismatch between documentation and the module on your system, ensure that the version you are using is the same as the documentation. Check this box if they match or the issue you are reporting is not version specific.

Module

PSScriptAnalyzer

Links

Summary

The rule actually has Information severity and doesn't have further configuration options.

Details

https://github.com/PowerShell/PSScriptAnalyzer/blob/1.21.0/Rules/AvoidUsingDoubleQuotesForConstantString.cs#L142

Suggested Fix

Change Severity to Information and remove Yes from Configurable.
@BenedekFarkas BenedekFarkas added issue-doc-bug Issue - error in documentation needs-triage Waiting - Needs triage labels Jan 12, 2023
BenedekFarkas added a commit to BenedekFarkas/PowerShell-Docs-Modules that referenced this issue Jan 12, 2023
@BenedekFarkas
Updating AvoidUsingDoubleQuotesForConstantString properties in PSScri…
01ad337 
…ptAnalyzer/Rules/Readme

Fixes MicrosoftDocs#128
This was referenced Jan 12, 2023
Merged
Closed
michaeltlombardi added a commit to michaeltlombardi/PSScriptAnalyzer that referenced this issue Jan 12, 2023
@michaeltlombardi
(MAINT) Fix AvoidUsingDoubleQuotesForConstantString in overview README
2b6e9a7 
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
@michaeltlombardi michaeltlombardi mentioned this issue Jan 12, 2023
Merged
6 tasks
michaeltlombardi pushed a commit that referenced this issue Jan 12, 2023
@BenedekFarkas
Updating AvoidUsingDoubleQuotesForConstantString properties in PSScri…
7463d5b 
…ptAnalyzer/Rules/Readme (#129)

Fixes #128
bergmeister pushed a commit to PowerShell/PSScriptAnalyzer that referenced this issue Feb 22, 2023
@michaeltlombardi
(MAINT) Fix AvoidUsingDoubleQuotesForConstantString in overview README (
19a6a18 
#1883)

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
issue-doc-bug Issue - error in documentation needs-triage Waiting - Needs triage
Projects
None yet
Milestone
No milestone
1 participant
@BenedekFarkas