Skip to content

Sync changes from Docs repository #1929

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Rules/AlignAssignmentStatement.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Align assignment statement
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AlignAssignmentStatement
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidAssignmentToAutomaticVariable.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Changing automatic variables might have undesired side effects
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidAssignmentToAutomaticVariable
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidDefaultValueForMandatoryParameter.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Default Value For Mandatory Parameter
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidDefaultValueForMandatoryParameter
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidDefaultValueSwitchParameter.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Switch Parameters Should Not Default To True
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidDefaultValueSwitchParameter
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidGlobalAliases.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid global aliases.
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidGlobalAliases
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidGlobalFunctions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid global functions and aliases
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidGlobalFunctions
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidGlobalVars.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: No Global Variables
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidGlobalVars
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidInvokingEmptyMembers.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Invoking Empty Members
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidInvokingEmptyMembers
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidLongLines.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid long lines
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidLongLines
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidMultipleTypeAttributes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid multiple type specifiers on parameters.
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidMultipleTypeAttributes
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidNullOrEmptyHelpMessageAttribute.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid using null or empty HelpMessage parameter attribute.
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidNullOrEmptyHelpMessageAttribute
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidOverwritingBuiltInCmdlets.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid overwriting built in cmdlets
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidOverwritingBuiltInCmdlets
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidSemicolonsAsLineTerminators.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid semicolons as line terminators
ms.custom: PSSA v1.21.0
ms.date: 06/15/2022
ms.date: 06/28/2023
ms.topic: reference
title: AvoidSemicolonsAsLineTerminators
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidShouldContinueWithoutForce.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using ShouldContinue Without Boolean Force Parameter
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidShouldContinueWithoutForce
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidTrailingWhitespace.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid trailing whitespace
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidTrailingWhitespace
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidUsingBrokenHashAlgorithms.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid using broken hash algorithms
ms.custom: PSSA v1.21.0
ms.date: 05/31/2022
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingBrokenHashAlgorithms
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidUsingCmdletAliases.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Cmdlet Aliases or omitting the 'Get-' prefix.
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingCmdletAliases
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidUsingComputerNameHardcoded.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using ComputerName Hardcoded
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingComputerNameHardcoded
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidUsingConvertToSecureStringWithPlainText.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using SecureString With Plain Text
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingConvertToSecureStringWithPlainText
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidUsingDeprecatedManifestFields.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Deprecated Manifest Fields
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingDeprecatedManifestFields
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidUsingDoubleQuotesForConstantString.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid using double quotes if the string is constant.
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingDoubleQuotesForConstantString
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidUsingEmptyCatchBlock.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Empty Catch Block
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingEmptyCatchBlock
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidUsingInvokeExpression.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Invoke-Expression
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingInvokeExpression
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidUsingPlainTextForPassword.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Plain Text For Password Parameter
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingPlainTextForPassword
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidUsingPositionalParameters.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Positional Parameters
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingPositionalParameters
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidUsingUsernameAndPasswordParams.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Username and Password Parameters
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingUsernameAndPasswordParams
---
Expand Down
6 changes: 3 additions & 3 deletions docs/Rules/AvoidUsingWMICmdlet.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Get-WMIObject, Remove-WMIObject, Invoke-WmiMethod, Register-WmiEvent, Set-WmiInstance
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingWMICmdlet
---
Expand All @@ -17,7 +17,7 @@ The following cmdlets should not be used:

- `Get-WmiObject`
- `Remove-WmiObject`
- `Invoke-WmiObject`
- `Invoke-WmiMethod`
- `Register-WmiEvent`
- `Set-WmiInstance`

Expand All @@ -38,7 +38,7 @@ Change to the equivalent CIM based cmdlet.

- `Get-WmiObject` -> `Get-CimInstance`
- `Remove-WmiObject` -> `Remove-CimInstance`
- `Invoke-WmiObject` -> `Invoke-CimMethod`
- `Invoke-WmiMethod` -> `Invoke-CimMethod`
- `Register-WmiEvent` -> `Register-CimIndicationEvent`
- `Set-WmiInstance` -> `Set-CimInstance`

Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/AvoidUsingWriteHost.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Write-Host
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingWriteHost
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/DSCDscExamplesPresent.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: DSC examples are present
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: DSCDscExamplesPresent
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/DSCDscTestsPresent.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Dsc tests are present
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: DSCDscTestsPresent
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/DSCReturnCorrectTypesForDSCFunctions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Return Correct Types For DSC Functions
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: DSCReturnCorrectTypesForDSCFunctions
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/DSCStandardDSCFunctionsInResource.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Use Standard Get/Set/Test TargetResource functions in DSC Resource
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: DSCStandardDSCFunctionsInResource
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/DSCUseIdenticalMandatoryParametersForDSC.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Use identical mandatory parameters for DSC Get/Test/Set TargetResource functions
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: DSCUseIdenticalMandatoryParametersForDSC
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/DSCUseIdenticalParametersForDSC.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Use Identical Parameters For DSC Test and Set Functions
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: DSCUseIdenticalParametersForDSC
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/DSCUseVerboseMessageInDSCResource.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Use verbose message in DSC resource
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: DSCUseVerboseMessageInDSCResource
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/MisleadingBacktick.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Misleading Backtick
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: MisleadingBacktick
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/MissingModuleManifestField.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Module Manifest Fields
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: MissingModuleManifestField
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/PlaceCloseBrace.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Place close braces
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: PlaceCloseBrace
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/PlaceOpenBrace.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Place open braces consistently
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: PlaceOpenBrace
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/PossibleIncorrectComparisonWithNull.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Null Comparison
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: PossibleIncorrectComparisonWithNull
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/PossibleIncorrectUsageOfAssignmentOperator.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Equal sign is not an assignment operator. Did you mean the equality operator \'-eq\'?
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: PossibleIncorrectUsageOfAssignmentOperator
---
Expand Down
2 changes: 1 addition & 1 deletion docs/Rules/PossibleIncorrectUsageOfRedirectionOperator.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: \'>\' is not a comparison operator. Use \'-gt\' (greater than) or \'-ge\' (greater or equal).
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: PossibleIncorrectUsageOfRedirectionOperator
---
Expand Down
Loading