diff --git a/README.md b/README.md index 0bee936a2..bd351ffc9 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,13 @@ on PowerShell best practices identified by PowerShell Team and the community. It DiagnosticResults (errors and warnings) to inform users about potential code defects and suggests possible solutions for improvements. -PSScriptAnalyzer is shipped with a collection of built-in rules that checks various aspects of -PowerShell code such as presence of uninitialized variables, usage of PSCredential Type, usage of -Invoke-Expression etc. Additional functionalities such as exclude/include specific rules are also -supported. +PSScriptAnalyzer ships with a collection of built-in rules that check various aspects of +PowerShell code such as: + +- The presence of uninitialized variables +- Use of **PSCredential** type +- Use of `Invoke-Expression` +- And many more [Back to ToC](#table-of-contents) diff --git a/docs/Cmdlets/Get-ScriptAnalyzerRule.md b/docs/Cmdlets/Get-ScriptAnalyzerRule.md index d1847def6..2efa05288 100644 --- a/docs/Cmdlets/Get-ScriptAnalyzerRule.md +++ b/docs/Cmdlets/Get-ScriptAnalyzerRule.md @@ -92,7 +92,7 @@ Enter the path to a .NET assembly or module that contains Script Analyzer rules. one value, but wildcards are supported. To get rules in subdirectories of the path, use the **RecurseCustomRulePath** parameter. -You can create custom rules by using a custom .NET assembly or a PowerShell module, such as the +You can create custom rules using a .NET assembly or a PowerShell module, such as the [Community Analyzer Rules](https://github.com/PowerShell/PSScriptAnalyzer/blob/development/Tests/Engine/CommunityAnalyzerRules/CommunityAnalyzerRules.psm1) in the GitHub repository. @@ -173,7 +173,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### None -You cannot pipe input to this cmdlet. +You can't pipe input to this cmdlet. ## OUTPUTS diff --git a/docs/Rules/ShouldProcess.md b/docs/Rules/ShouldProcess.md index 37e85a30a..ed954932f 100644 --- a/docs/Rules/ShouldProcess.md +++ b/docs/Rules/ShouldProcess.md @@ -18,8 +18,8 @@ but makes no calls to `ShouldProcess` or it calls `ShouldProcess` but does not d For more information, see the following articles: -- [about_Functions_Advanced_Methods](/powershell/modules/microsoft.powershell.core/about/about_Functions_Advanced_Methods) -- [about_Functions_CmdletBindingAttribute](/powershell/modules/microsoft.powershell.core/about/about_Functions_CmdletBindingAttribute) +- [about_Functions_Advanced_Methods](/powershell/module/microsoft.powershell.core/about/about_functions_advanced_methods) +- [about_Functions_CmdletBindingAttribute](/powershell/module/microsoft.powershell.core/about/about_Functions_CmdletBindingAttribute) - [Everything you wanted to know about ShouldProcess](/powershell/scripting/learn/deep-dives/everything-about-shouldprocess) ## How