Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Backport MSDocs changes#2085

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
andyleejordan merged 5 commits intoPowerShell:mainfrombergmeister:24.0-docsbackport
Mar 17, 2025

Conversation

@bergmeister
Copy link
Collaborator

@bergmeisterbergmeister commentedMar 15, 2025
edited
Loading

PR Summary

Backported PRs:

PR Checklist

@bergmeisterbergmeister changed the titleBackport MSDmsdocs changes. Where references to files in MSD…Backport MSDocs changesMar 15, 2025
@bergmeisterbergmeister added the Area - Documentation BackportBackport of docs changes in PowerShell-Docs-Modules repo labelMar 15, 2025
sdwheelerand others added3 commitsMarch 15, 2025 15:53
…ocs were present (e.g. in UseShouldProcessForStateChangingFunctions), replaced with the live URLs. Did not port back TODO block of AvoidAssignmentToAutomaticVariable.md fromhttps://github.com/MicrosoftDocs/PowerShell-Docs-Modules/pull/241/files#diff-1db3dc2f98da1fa58e24bac28ea9f14f507c78d8299349aa0196f01f9479b6f5Backported PRs:-https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/pull/281/files-MicrosoftDocs/PowerShell-Docs-Modules@ff80de6-https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/pull/275/files-MicrosoftDocs/PowerShell-Docs-Modules#278-https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/pull/235/files-https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/pull/276/files-MicrosoftDocs/PowerShell-Docs-Modules#273-MicrosoftDocs/PowerShell-Docs-Modules#285-MicrosoftDocs/PowerShell-Docs-Modules@6ca872b#diff-b3e50d455fe1b464a6fec38ac616cbde4a412766a05a606c1ae55be90ccb63a3-MicrosoftDocs/PowerShell-Docs-Modules#277
@sdwheeler
Copy link
Collaborator

@bergmeister I had changes in flight for this already and my changes had a few things you missed. I added my changes to this PR.

bergmeister reacted with thumbs up emoji

Copy link
Collaborator

@sdwheelersdwheeler left a comment

Choose a reason for hiding this comment

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

LGTM

Comment on lines +19 to +23
<!-- TODO
Ability to suppress was added in https://github.com/PowerShell/PSScriptAnalyzer/pull/1896
Need documentation for how to configure suppression of this rule.
-->

Copy link
CollaboratorAuthor

Choose a reason for hiding this comment

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

In my original PR I left this out because this comment relates more to work in MSDocs. Maybe a GitHub issue is a better place for it than a comment?

Copy link
Collaborator

Choose a reason for hiding this comment

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

We should add this information in both repos before release. I couldn't figure out how to configure this. Can you provide an example?

Copy link
CollaboratorAuthor

Choose a reason for hiding this comment

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

Suppression is not different that any other rule. For example[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidAssignmentToAutomaticVariable', '')] suppresses the rule and[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidAssignmentToAutomaticVariable', 'PID')] makes the suppression specific to assignment to$PID automatic variable

Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you only do this in code? Other rules can be configured using JSON. For example:https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/usesingularnouns#configuration

Copy link
CollaboratorAuthor

Choose a reason for hiding this comment

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

Suppression is only possible via annotating code with this attribute unless one decided to not run rule at all via PSSA settings but I wouldn't call that suppression:https://learn.microsoft.com/en-us/powershell/utility-modules/psscriptanalyzer/using-scriptanalyzer?view=ps-modules#suppressing-rules
What you reference is rule configuration as part of PSSA settings, which is not JSON, it's PowerShell's hashtable format:https://learn.microsoft.com/en-us/powershell/utility-modules/psscriptanalyzer/using-scriptanalyzer?view=ps-modules#settings-support-in-scriptanalyzer

Co-authored-by: Christoph Bergmeister <c.bergmeister@gmail.com>
Co-authored-by: Christoph Bergmeister <c.bergmeister@gmail.com>
@andyleejordanandyleejordan merged commit28081e5 intoPowerShell:mainMar 17, 2025
4 checks passed
@andyleejordan
Copy link
Member

@sdwheeler@bergmeister this seems to have removed some information from#1704 fordocs/Rules/UseCorrectCasing.md specifically around keywords and operators. Was that intentional?

@sdwheeler
Copy link
Collaborator

I have had so many issues with the docs branches. I had a draft update for UserCorrectCasing.md that has gone missing. Let me see if I can find it and update again.

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@sdwheelersdwheelersdwheeler approved these changes

@michaeltlombardimichaeltlombardiAwaiting requested review from michaeltlombardimichaeltlombardi is a code owner

@andyleejordanandyleejordanAwaiting requested review from andyleejordan

Assignees

No one assigned

Labels

Area - Documentation BackportBackport of docs changes in PowerShell-Docs-Modules repoArea - Documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@bergmeister@sdwheeler@andyleejordan

[8]ページ先頭

©2009-2025 Movatter.jp