Skip to content

Update cmdlet docs for OPS13 #703

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.

Sign up for GitHub

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
Oct 26, 2024
Merged

Update cmdlet docs for OPS13 #703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/cmdlet-reference/Microsoft.PowerShell.PlatyPS/Compare-CommandHelp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: Microsoft.PowerShell.PlatyPS
ms.custom: OPS10
ms.date: 09/17/2024
ms.custom: OPS13
ms.date: 10/25/2024
PlatyPS schema version: 2024-05-01
title: Compare-CommandHelp
---
Expand Down
4 changes: 2 additions & 2 deletions docs/cmdlet-reference/Microsoft.PowerShell.PlatyPS/Export-MamlCommandHelp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: Microsoft.PowerShell.PlatyPS
ms.custom: OPS10
ms.date: 09/17/2024
ms.custom: OPS13
ms.date: 10/25/2024
PlatyPS schema version: 2024-05-01
title: Export-MamlCommandHelp
---
Expand Down
4 changes: 2 additions & 2 deletions docs/cmdlet-reference/Microsoft.PowerShell.PlatyPS/Export-MarkdownCommandHelp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: Microsoft.PowerShell.PlatyPS
ms.custom: OPS10
ms.date: 09/17/2024
ms.custom: OPS13
ms.date: 10/25/2024
PlatyPS schema version: 2024-05-01
title: Export-MarkdownCommandHelp
---
Expand Down
4 changes: 2 additions & 2 deletions docs/cmdlet-reference/Microsoft.PowerShell.PlatyPS/Export-MarkdownModuleFile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: Microsoft.PowerShell.PlatyPS
ms.custom: OPS10
ms.date: 09/17/2024
ms.custom: OPS13
ms.date: 10/25/2024
PlatyPS schema version: 2024-05-01
title: Export-MarkdownModuleFile
---
Expand Down
4 changes: 2 additions & 2 deletions docs/cmdlet-reference/Microsoft.PowerShell.PlatyPS/Export-YamlCommandHelp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: Microsoft.PowerShell.PlatyPS
ms.custom: OPS10
ms.date: 09/17/2024
ms.custom: OPS13
ms.date: 10/25/2024
PlatyPS schema version: 2024-05-01
title: Export-YamlCommandHelp
---
Expand Down
4 changes: 2 additions & 2 deletions docs/cmdlet-reference/Microsoft.PowerShell.PlatyPS/Export-YamlModuleFile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: Microsoft.PowerShell.PlatyPS
ms.custom: OPS10
ms.date: 09/17/2024
ms.custom: OPS13
ms.date: 10/25/2024
PlatyPS schema version: 2024-05-01
title: Export-YamlModuleFile
---
Expand Down
6 changes: 3 additions & 3 deletions docs/cmdlet-reference/Microsoft.PowerShell.PlatyPS/Import-MamlHelp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: Microsoft.PowerShell.PlatyPS
ms.custom: OPS10
ms.date: 09/17/2024
ms.custom: OPS13
ms.date: 10/25/2024
PlatyPS schema version: 2024-05-01
title: Import-MamlHelp
---
Expand Down Expand Up @@ -83,7 +83,7 @@ The path to the MAML help file. Specifies a path to one or more locations.
```yaml
Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
SupportsWildcards: true
ParameterValue: []
Aliases: []
ParameterSets:
Expand Down
6 changes: 3 additions & 3 deletions docs/cmdlet-reference/Microsoft.PowerShell.PlatyPS/Import-MarkdownCommandHelp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: Microsoft.PowerShell.PlatyPS
ms.custom: OPS10
ms.date: 09/17/2024
ms.custom: OPS13
ms.date: 10/25/2024
PlatyPS schema version: 2024-05-01
title: Import-MarkdownCommandHelp
---
Expand Down Expand Up @@ -117,7 +117,7 @@ items in the current location.
```yaml
Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
SupportsWildcards: true
ParameterValue: []
Aliases: []
ParameterSets:
Expand Down
6 changes: 3 additions & 3 deletions docs/cmdlet-reference/Microsoft.PowerShell.PlatyPS/Import-MarkdownModuleFile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: Microsoft.PowerShell.PlatyPS
ms.custom: OPS10
ms.date: 09/17/2024
ms.custom: OPS13
ms.date: 10/25/2024
PlatyPS schema version: 2024-05-01
title: Import-MarkdownModuleFile
---
Expand Down Expand Up @@ -99,7 +99,7 @@ items in the current location.
```yaml
Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
SupportsWildcards: true
ParameterValue: []
Aliases: []
ParameterSets:
Expand Down
6 changes: 3 additions & 3 deletions docs/cmdlet-reference/Microsoft.PowerShell.PlatyPS/Import-YamlCommandHelp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: Microsoft.PowerShell.PlatyPS
ms.custom: OPS10
ms.date: 09/17/2024
ms.custom: OPS13
ms.date: 10/25/2024
PlatyPS schema version: 2024-05-01
title: Import-YamlCommandHelp
---
Expand Down Expand Up @@ -133,7 +133,7 @@ The path to the Yaml command file. Specifies a path to one or more locations.
```yaml
Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
SupportsWildcards: true
ParameterValue: []
Aliases:
- FullName
Expand Down
4 changes: 2 additions & 2 deletions docs/cmdlet-reference/Microsoft.PowerShell.PlatyPS/Import-YamlModuleFile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: Microsoft.PowerShell.PlatyPS
ms.custom: OPS10
ms.date: 09/17/2024
ms.custom: OPS13
ms.date: 10/25/2024
PlatyPS schema version: 2024-05-01
title: Import-YamlModuleFile
---
Expand Down
4 changes: 2 additions & 2 deletions docs/cmdlet-reference/Microsoft.PowerShell.PlatyPS/Measure-PlatyPSMarkdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: Microsoft.PowerShell.PlatyPS
ms.custom: OPS10
ms.date: 09/17/2024
ms.custom: OPS13
ms.date: 10/25/2024
PlatyPS schema version: 2024-05-01
title: Measure-PlatyPSMarkdown
---
Expand Down
15 changes: 12 additions & 3 deletions docs/cmdlet-reference/Microsoft.PowerShell.PlatyPS/Microsoft.PowerShell.PlatyPS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
document type: module
HelpInfoUri: ''
Help Version: 1.0.0.0
HelpInfoUri: https://somehost/somepath/
Locale: en-US
Module Guid: 0bdcabef-a4b7-4a6d-bf7e-d879817ebbff
Module Name: Microsoft.PowerShell.PlatyPS
ms.custom: OPS10
ms.date: 09/18/2024
ms.custom: OPS13
ms.date: 10/26/2024
PlatyPS schema version: 2024-05-01
title: Microsoft.PowerShell.PlatyPS Module
---
Expand Down Expand Up @@ -70,6 +71,10 @@ Determines the type of Markdown file.

Creates **CommandHelp** objects for a PowerShell command that's loaded in the session.

### [New-HelpCabinetFile](New-HelpCabinetFile.md)

Creates a help cabinet file for a module that can be published as updateable help content.

### [New-MarkdownCommandHelp](New-MarkdownCommandHelp.md)

Creates Markdown help files for PowerShell modules and commands.
Expand All @@ -78,6 +83,10 @@ Creates Markdown help files for PowerShell modules and commands.

Creates the Markdown module file for a PowerShell module.

### [Show-HelpPreview](Show-HelpPreview.md)

View MAML file contents as it would appear when output by `Get-Help`.

### [Test-MarkdownCommandHelp](Test-MarkdownCommandHelp.md)

Tests the structure of a Markdown help file.
Expand Down
4 changes: 2 additions & 2 deletions docs/cmdlet-reference/Microsoft.PowerShell.PlatyPS/New-CommandHelp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml
HelpUri: ''
Locale: en-US
Module Name: Microsoft.PowerShell.PlatyPS
ms.custom: OPS10
ms.date: 09/17/2024
ms.custom: OPS13
ms.date: 10/25/2024
PlatyPS schema version: 2024-05-01
title: New-CommandHelp
---
Expand Down
Loading