Skip to content

Commit 811c3fb

Browse files
authored
Upddate PlatyPS ref for RC1 (#332)
* Upddate PlatyPS ref for RC1 * Fix syntax blocks and remove -HelpUri
1 parent bbf4df9 commit 811c3fb

22 files changed

+1687
-1100
lines changed

reference/ps-modules/Microsoft.PowerShell.PlatyPS/Compare-CommandHelp.md

Lines changed: 48 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
---
1+
---
2+
document type: cmdlet
23
external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml
3-
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/compare-commandhelp?view=ps-modules&WT.mc_id=ps-gethelp
4+
HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/compare-commandhelp?view=ps-modules&WT.mc_id=ps-gethelp
45
Locale: en-US
56
Module Name: Microsoft.PowerShell.PlatyPS
6-
ms.custom: preview1
7-
ms.date: 10/25/2024
8-
schema: 2.0.0
7+
ms.date: 07/17/2025
8+
PlatyPS schema version: 2024-05-01
99
title: Compare-CommandHelp
1010
---
1111

@@ -24,6 +24,8 @@ Compare-CommandHelp [-ReferenceCommandHelp] <CommandHelp> [-DifferenceCommandHel
2424
[-PropertyNamesToExclude <string[]>] [<CommonParameters>]
2525
```
2626

27+
## ALIASES
28+
2729
## DESCRIPTION
2830

2931
`Compare-CommandHelp` is a troubleshooting tool that compares two CommandHelp objects and produces a
@@ -48,14 +50,19 @@ The CommandHelp object to compare against the reference object.
4850

4951
```yaml
5052
Type: Microsoft.PowerShell.PlatyPS.Model.CommandHelp
51-
Parameter Sets: (All)
52-
Aliases:
53-
Accepted values:
54-
Required: True
55-
Position: 1
56-
Default value: None
57-
Accept pipeline input: True (ByPropertyName)
58-
Accept wildcard characters: False
53+
DefaultValue: None
54+
SupportsWildcards: false
55+
Aliases: []
56+
ParameterSets:
57+
- Name: (All)
58+
Position: 1
59+
IsRequired: true
60+
ValueFromPipeline: false
61+
ValueFromPipelineByPropertyName: true
62+
ValueFromRemainingArguments: false
63+
DontShow: false
64+
AcceptedValues: []
65+
HelpMessage: ''
5966
```
6067
6168
### -PropertyNamesToExclude
@@ -64,14 +71,19 @@ A list of one or more property names to exclude from the comparison.
6471
6572
```yaml
6673
Type: System.String[]
67-
Parameter Sets: (All)
68-
Aliases:
69-
Accepted values:
70-
Required: False
71-
Position: Named
72-
Default value: None
73-
Accept pipeline input: False
74-
Accept wildcard characters: False
74+
DefaultValue: None
75+
SupportsWildcards: false
76+
Aliases: []
77+
ParameterSets:
78+
- Name: (All)
79+
Position: Named
80+
IsRequired: false
81+
ValueFromPipeline: false
82+
ValueFromPipelineByPropertyName: false
83+
ValueFromRemainingArguments: false
84+
DontShow: false
85+
AcceptedValues: []
86+
HelpMessage: ''
7587
```
7688
7789
### -ReferenceCommandHelp
@@ -80,14 +92,19 @@ The base CommandHelp object to be compared to the difference object.
8092
8193
```yaml
8294
Type: Microsoft.PowerShell.PlatyPS.Model.CommandHelp
83-
Parameter Sets: (All)
84-
Aliases:
85-
Accepted values:
86-
Required: True
87-
Position: 0
88-
Default value: None
89-
Accept pipeline input: True (ByPropertyName)
90-
Accept wildcard characters: False
95+
DefaultValue: None
96+
SupportsWildcards: false
97+
Aliases: []
98+
ParameterSets:
99+
- Name: (All)
100+
Position: 0
101+
IsRequired: true
102+
ValueFromPipeline: false
103+
ValueFromPipelineByPropertyName: true
104+
ValueFromRemainingArguments: false
105+
DontShow: false
106+
AcceptedValues: []
107+
HelpMessage: ''
91108
```
92109
93110
### CommonParameters
@@ -109,6 +126,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
109126
110127
## RELATED LINKS
111128
112-
[Import-MarkdownCommandHelp](Import-MarkdownCommandHelp.md)
113-
114-
[Import-YamlCommandHelp](Import-YamlCommandHelp.md)
129+
- [Import-MarkdownCommandHelp](Import-MarkdownCommandHelp.md)
130+
- [Import-YamlCommandHelp](Import-YamlCommandHelp.md)
Lines changed: 90 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
---
1+
---
2+
document type: cmdlet
23
external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml
3-
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/export-mamlcommandhelp?view=ps-modules&WT.mc_id=ps-gethelp
4+
HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/export-mamlcommandhelp?view=ps-modules&WT.mc_id=ps-gethelp
45
Locale: en-US
56
Module Name: Microsoft.PowerShell.PlatyPS
6-
ms.custom: preview1
7-
ms.date: 10/25/2024
8-
schema: 2.0.0
7+
ms.date: 07/17/2025
8+
PlatyPS schema version: 2024-05-01
99
title: Export-MamlCommandHelp
1010
---
1111

@@ -24,6 +24,8 @@ Export-MamlCommandHelp [-CommandHelp] <CommandHelp[]> [-OutputFolder] <string>
2424
[-Encoding <Encoding>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
2525
```
2626

27+
## ALIASES
28+
2729
## DESCRIPTION
2830

2931
This command converts **CommandHelp** objects to a MAML file. The MAML file contains help content in
@@ -56,14 +58,19 @@ One or more **CommandHelp** objects to export.
5658

5759
```yaml
5860
Type: Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]
59-
Parameter Sets: (All)
60-
Aliases:
61-
Accepted values:
62-
Required: True
63-
Position: 0
64-
Default value: None
65-
Accept pipeline input: True (ByValue)
66-
Accept wildcard characters: False
61+
DefaultValue: None
62+
SupportsWildcards: false
63+
Aliases: []
64+
ParameterSets:
65+
- Name: (All)
66+
Position: 0
67+
IsRequired: true
68+
ValueFromPipeline: true
69+
ValueFromPipelineByPropertyName: false
70+
ValueFromRemainingArguments: false
71+
DontShow: false
72+
AcceptedValues: []
73+
HelpMessage: ''
6774
```
6875
6976
### -Confirm
@@ -72,14 +79,20 @@ Prompts you for confirmation before running the cmdlet.
7279
7380
```yaml
7481
Type: System.Management.Automation.SwitchParameter
75-
Parameter Sets: (All)
76-
Aliases: cf
77-
Accepted values:
78-
Required: False
79-
Position: Named
80-
Default value: False
81-
Accept pipeline input: False
82-
Accept wildcard characters: False
82+
DefaultValue: False
83+
SupportsWildcards: false
84+
Aliases:
85+
- cf
86+
ParameterSets:
87+
- Name: (All)
88+
Position: Named
89+
IsRequired: false
90+
ValueFromPipeline: false
91+
ValueFromPipelineByPropertyName: false
92+
ValueFromRemainingArguments: false
93+
DontShow: false
94+
AcceptedValues: []
95+
HelpMessage: ''
8396
```
8497
8598
### -Encoding
@@ -89,14 +102,19 @@ the value of the `$OutputEncoding` preference variable.
89102

90103
```yaml
91104
Type: System.Text.Encoding
92-
Parameter Sets: (All)
93-
Aliases:
94-
Accepted values:
95-
Required: False
96-
Position: Named
97-
Default value: False
98-
Accept pipeline input: False
99-
Accept wildcard characters: False
105+
DefaultValue: False
106+
SupportsWildcards: false
107+
Aliases: []
108+
ParameterSets:
109+
- Name: (All)
110+
Position: Named
111+
IsRequired: false
112+
ValueFromPipeline: false
113+
ValueFromPipelineByPropertyName: false
114+
ValueFromRemainingArguments: false
115+
DontShow: false
116+
AcceptedValues: []
117+
HelpMessage: ''
100118
```
101119

102120
### -Force
@@ -105,14 +123,19 @@ Use the **Force** parameter to overwrite the output file if it already exists.
105123

106124
```yaml
107125
Type: System.Management.Automation.SwitchParameter
108-
Parameter Sets: (All)
109-
Aliases:
110-
Accepted values:
111-
Required: False
112-
Position: Named
113-
Default value: False
114-
Accept pipeline input: False
115-
Accept wildcard characters: False
126+
DefaultValue: False
127+
SupportsWildcards: false
128+
Aliases: []
129+
ParameterSets:
130+
- Name: (All)
131+
Position: Named
132+
IsRequired: false
133+
ValueFromPipeline: false
134+
ValueFromPipelineByPropertyName: false
135+
ValueFromRemainingArguments: false
136+
DontShow: false
137+
AcceptedValues: []
138+
HelpMessage: ''
116139
```
117140

118141
### -OutputFolder
@@ -121,30 +144,41 @@ The folder where the markdown file is saved. If the folder doesn't exist, it's c
121144

122145
```yaml
123146
Type: System.String
124-
Parameter Sets: (All)
125-
Aliases:
126-
Accepted values:
127-
Required: True
128-
Position: 1
129-
Default value: None
130-
Accept pipeline input: False
131-
Accept wildcard characters: False
147+
DefaultValue: None
148+
SupportsWildcards: false
149+
Aliases: []
150+
ParameterSets:
151+
- Name: (All)
152+
Position: 1
153+
IsRequired: true
154+
ValueFromPipeline: false
155+
ValueFromPipelineByPropertyName: false
156+
ValueFromRemainingArguments: false
157+
DontShow: false
158+
AcceptedValues: []
159+
HelpMessage: ''
132160
```
133161

134162
### -WhatIf
135163

136-
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
164+
Runs the command in a mode that only reports what would happen without performing the actions.
137165

138166
```yaml
139167
Type: System.Management.Automation.SwitchParameter
140-
Parameter Sets: (All)
141-
Aliases: wi
142-
Accepted values:
143-
Required: False
144-
Position: Named
145-
Default value: False
146-
Accept pipeline input: False
147-
Accept wildcard characters: False
168+
DefaultValue: False
169+
SupportsWildcards: false
170+
Aliases:
171+
- wi
172+
ParameterSets:
173+
- Name: (All)
174+
Position: Named
175+
IsRequired: false
176+
ValueFromPipeline: false
177+
ValueFromPipelineByPropertyName: false
178+
ValueFromRemainingArguments: false
179+
DontShow: false
180+
AcceptedValues: []
181+
HelpMessage: ''
148182
```
149183

150184
### CommonParameters
@@ -156,7 +190,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
156190

157191
## INPUTS
158192

159-
### Microsoft.PowerShell.PlatyPS.Model.CommandHelp
193+
### Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]
160194

161195
## OUTPUTS
162196

@@ -166,4 +200,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
166200

167201
## RELATED LINKS
168202

169-
[Import-MarkdownCommandHelp](Import-MarkdownCommandHelp.md)
203+
- [Import-MarkdownCommandHelp](Import-MarkdownCommandHelp.md)

0 commit comments

Comments
 (0)