Skip to content

Commit e5a93ad

Browse files
Maddie Claytonvors
authored andcommitted
Add "UseFullName" parameter to Update-MarkdownHelpModule (#380)
1 parent c24914a commit e5a93ad

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

docs/Update-MarkdownHelpModule.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Update all files in a markdown help module folder.
1414

1515
```
1616
Update-MarkdownHelpModule [-Path] <String[]> [[-Encoding] <Encoding>] [-RefreshModulePage]
17-
[[-LogPath] <String>] [-LogAppend] [-AlphabeticParamsOrder] [-Session <PSSession>] [<CommonParameters>]
17+
[[-LogPath] <String>] [-LogAppend] [-AlphabeticParamsOrder] [-UseFullTypeName] [-Session <PSSession>]
18+
[<CommonParameters>]
1819
```
1920

2021
## DESCRIPTION
@@ -167,6 +168,21 @@ Accept pipeline input: False
167168
Accept wildcard characters: False
168169
```
169170

171+
### -UseFullTypeName
172+
Indicates that the target document will use a full type name instead of a short name for parameters.
173+
174+
```yaml
175+
Type: SwitchParameter
176+
Parameter Sets: (All)
177+
Aliases:
178+
179+
Required: False
180+
Position: Named
181+
Default value: None
182+
Accept pipeline input: False
183+
Accept wildcard characters: False
184+
```
185+
170186
### CommonParameters
171187
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
172188

src/platyPS/platyPS.psm1

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -561,6 +561,7 @@ function Update-MarkdownHelpModule
561561
[string]$LogPath,
562562
[switch]$LogAppend,
563563
[switch]$AlphabeticParamsOrder,
564+
[switch]$UseFullTypeName,
564565

565566
[System.Management.Automation.Runspaces.PSSession]$Session
566567
)
@@ -615,7 +616,7 @@ function Update-MarkdownHelpModule
615616
# always append on this call
616617
log ("[Update-MarkdownHelpModule]" + (Get-Date).ToString())
617618
log ("Updating docs for Module " + $module + " in " + $modulePath)
618-
$affectedFiles = Update-MarkdownHelp -Session $Session -Path $modulePath -LogPath $LogPath -LogAppend -Encoding $Encoding -AlphabeticParamsOrder:$AlphabeticParamsOrder
619+
$affectedFiles = Update-MarkdownHelp -Session $Session -Path $modulePath -LogPath $LogPath -LogAppend -Encoding $Encoding -AlphabeticParamsOrder:$AlphabeticParamsOrder -UseFullTypeName:$UseFullTypeName
619620
$affectedFiles # yeild
620621

621622
$allCommands = GetCommands -AsNames -Module $Module

0 commit comments

Comments
 (0)