GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Fix `AvoidUsingDoubleQuotesForConstantString` information in overview README by michaeltlombardi · Pull Request #1883 · PowerShell/PSScriptAnalyzer

Conversation

@michaeltlombardi

@michaeltlombardi Mikey Lombardi (He/Him) (michaeltlombardi) commented Jan 12, 2023

Copy link
Copy Markdown
Collaborator

PR Summary

As identified1 by Benedek Farkas (@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 Information2 and there aren't any configurable options.

This change copies the fix Benedek Farkas (@BenedekFarkas) kindly submitted to the docs site to ensure the documentation stays up-to-date.

PR Checklist

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • Change is not breaking
  • Make sure all .cs, .ps1 and .psm1 files have the correct copyright header
  • Make sure you've added a new test if existing tests do not effectively test the code changed and/or updated documentation
  • This PR is ready to merge and is not Work in Progress.
    • If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready.

Footnotes

  1. For more information, see:

    • Documentation is outdated on the AvoidUsingDoubleQuotesForConstantString rule's Severity and Configurability MicrosoftDocs/PowerShell-Docs-Modules#128
    ↩

  2. Source code:

    https://github.com/PowerShell/PSScriptAnalyzer/blob/9a6ce978d870909e688d9da0d101d3fc00b504f0/Rules/AvoidUsingDoubleQuotesForConstantString.cs#L142 ↩

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@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
bergmeister
Christoph Bergmeister (bergmeister) approved these changes Feb 22, 2023
View reviewed changes

@bergmeister Christoph Bergmeister (bergmeister) left a comment

Copy link
Copy Markdown
Collaborator

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making that change. This is corect

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
BenedekFarkas reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@bergmeister Christoph Bergmeister (bergmeister) changed the title (MAINT) Fix AvoidUsingDoubleQuotesForConstantString information in overview README Fix AvoidUsingDoubleQuotesForConstantString information in overview README Feb 22, 2023
@bergmeister
Christoph Bergmeister (bergmeister) merged commit 19a6a18 into PowerShell:master Feb 22, 2023
This was referenced Mar 16, 2024
Update PSScriptAnalyzer to v1.22.0 ForNeVeR/intellij-powershell-fork#1
Closed
Update PSScriptAnalyzer to v1.22.0 intellij-powershell/intellij-powershell#244
Merged
Update PowerShellEditorServices to v3.18.1 and PSScriptAnalyzer to v1.22.0 ForNeVeR/intellij-powershell-fork#2
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bergmeister Christoph Bergmeister (bergmeister) bergmeister approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@michaeltlombardi @bergmeister
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.