Skip to content

Commit 0be5a01

Browse files
authored
Add metadata to docs (#1731)
1 parent 71f44d6 commit 0be5a01

File tree

71 files changed

+530
-62
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+530
-62
lines changed

docs/Cmdlets/Get-ScriptAnalyzerRule.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
---
1+
---
22
external help file: Microsoft.Windows.PowerShell.ScriptAnalyzer.dll-Help.xml
33
Module Name: PSScriptAnalyzer
4+
ms.custom: PSSA v1.20.0
45
ms.date: 10/07/2021
56
online version: https://docs.microsoft.com/powershell/module/psscriptanalyzer/get-scriptanalyzerrule?view=ps-modules&wt.mc_id=ps-gethelp
67
schema: 2.0.0

docs/Cmdlets/Invoke-Formatter.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
---
1+
---
22
external help file: Microsoft.Windows.PowerShell.ScriptAnalyzer.dll-Help.xml
33
Module Name: PSScriptAnalyzer
4+
ms.custom: PSSA v1.20.0
45
ms.date: 10/07/2021
56
online version: https://docs.microsoft.com/powershell/module/psscriptanalyzer/invoke-formatter?view=ps-modules&wt.mc_id=ps-gethelp
67
schema: 2.0.0

docs/Cmdlets/Invoke-ScriptAnalyzer.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
---
1+
---
22
external help file: Microsoft.Windows.PowerShell.ScriptAnalyzer.dll-Help.xml
33
Module Name: PSScriptAnalyzer
4+
ms.custom: PSSA v1.20.0
45
ms.date: 10/07/2021
56
online version: https://docs.microsoft.com/powershell/module/psscriptanalyzer/invoke-scriptanalyzer?view=ps-modules&wt.mc_id=ps-gethelp
67
schema: 2.0.0

docs/Cmdlets/PSScriptAnalyzer.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
---
2-
Module Name: PSScriptAnalyzer
3-
Module Guid: d6245802-193d-4068-a631-8863a4342a18
4-
ms.date: 10/07/2021
5-
Download Help Link: https://aka.ms/ps-modules-help
1+
---
2+
Download Help Link: https://aka.ms/ps-modules-help
63
Help Version: 1.20.0
74
Locale: en-US
5+
Module Guid: d6245802-193d-4068-a631-8863a4342a18
6+
Module Name: PSScriptAnalyzer
7+
ms.custom: PSSA v1.20.0
8+
ms.date: 10/07/2021
89
---
910

1011
# PSScriptAnalyzer Module

docs/Rules/AlignAssignmentStatement.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
# AlignAssignmentStatement
1+
---
2+
description: Align assignment statement
3+
ms.custom: PSSA v1.20.0
4+
ms.date: 10/18/2021
5+
ms.topic: reference
6+
title: AlignAssignmentStatement
7+
---
8+
# AlignAssignmentStatement
29

310
**Severity Level: Warning**
411

docs/Rules/AvoidAssignmentToAutomaticVariable.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
description: Changing automatic variables might have undesired side effects
3+
ms.custom: PSSA v1.20.0
4+
ms.date: 10/18/2021
5+
ms.topic: reference
6+
title: AvoidAssignmentToAutomaticVariable
7+
---
18
# AvoidAssignmentToAutomaticVariable
29

310
**Severity Level: Warning**

docs/Rules/AvoidDefaultValueForMandatoryParameter.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
description: Avoid Default Value For Mandatory Parameter
3+
ms.custom: PSSA v1.20.0
4+
ms.date: 10/18/2021
5+
ms.topic: reference
6+
title: AvoidDefaultValueForMandatoryParameter
7+
---
18
# AvoidDefaultValueForMandatoryParameter
29

310
**Severity Level: Warning**

docs/Rules/AvoidDefaultValueSwitchParameter.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
description: Switch Parameters Should Not Default To True
3+
ms.custom: PSSA v1.20.0
4+
ms.date: 10/18/2021
5+
ms.topic: reference
6+
title: AvoidDefaultValueSwitchParameter
7+
---
18
# AvoidDefaultValueSwitchParameter
29

310
**Severity Level: Warning**

docs/Rules/AvoidGlobalAliases.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
description: Avoid global aliases.
3+
ms.custom: PSSA v1.20.0
4+
ms.date: 10/18/2021
5+
ms.topic: reference
6+
title: AvoidGlobalAliases
7+
---
18
# AvoidGlobalAliases
29

310
**Severity Level: Warning**

docs/Rules/AvoidGlobalFunctions.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
description: Avoid global functions and aliases
3+
ms.custom: PSSA v1.20.0
4+
ms.date: 10/18/2021
5+
ms.topic: reference
6+
title: AvoidGlobalFunctions
7+
---
18
# AvoidGlobalFunctions
29

310
**Severity Level: Warning**

0 commit comments

Comments
 (0)