Skip to content

Commit 6790ebb

Browse files
authored
Sync remaining docs changes from Microsoft docs (#1835)
1 parent b2e6149 commit 6790ebb

File tree

3 files changed

+11
-8
lines changed

3 files changed

+11
-8
lines changed

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,13 @@ on PowerShell best practices identified by PowerShell Team and the community. It
2727
DiagnosticResults (errors and warnings) to inform users about potential code defects and suggests
2828
possible solutions for improvements.
2929

30-
PSScriptAnalyzer is shipped with a collection of built-in rules that checks various aspects of
31-
PowerShell code such as presence of uninitialized variables, usage of PSCredential Type, usage of
32-
Invoke-Expression etc. Additional functionalities such as exclude/include specific rules are also
33-
supported.
30+
PSScriptAnalyzer ships with a collection of built-in rules that check various aspects of
31+
PowerShell code such as:
32+
33+
- The presence of uninitialized variables
34+
- Use of **PSCredential** type
35+
- Use of `Invoke-Expression`
36+
- And many more
3437

3538
[Back to ToC](#table-of-contents)
3639

docs/Cmdlets/Get-ScriptAnalyzerRule.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Enter the path to a .NET assembly or module that contains Script Analyzer rules.
9292
one value, but wildcards are supported. To get rules in subdirectories of the path, use the
9393
**RecurseCustomRulePath** parameter.
9494

95-
You can create custom rules by using a custom .NET assembly or a PowerShell module, such as the
95+
You can create custom rules using a .NET assembly or a PowerShell module, such as the
9696
[Community Analyzer Rules](https://github.com/PowerShell/PSScriptAnalyzer/blob/development/Tests/Engine/CommunityAnalyzerRules/CommunityAnalyzerRules.psm1)
9797
in the GitHub repository.
9898

@@ -173,7 +173,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
173173

174174
### None
175175

176-
You cannot pipe input to this cmdlet.
176+
You can't pipe input to this cmdlet.
177177

178178
## OUTPUTS
179179

docs/Rules/ShouldProcess.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ but makes no calls to `ShouldProcess` or it calls `ShouldProcess` but does not d
1818

1919
For more information, see the following articles:
2020

21-
- [about_Functions_Advanced_Methods](/powershell/modules/microsoft.powershell.core/about/about_Functions_Advanced_Methods)
22-
- [about_Functions_CmdletBindingAttribute](/powershell/modules/microsoft.powershell.core/about/about_Functions_CmdletBindingAttribute)
21+
- [about_Functions_Advanced_Methods](/powershell/module/microsoft.powershell.core/about/about_functions_advanced_methods)
22+
- [about_Functions_CmdletBindingAttribute](/powershell/module/microsoft.powershell.core/about/about_Functions_CmdletBindingAttribute)
2323
- [Everything you wanted to know about ShouldProcess](/powershell/scripting/learn/deep-dives/everything-about-shouldprocess)
2424

2525
## How

0 commit comments

Comments
 (0)