Skip to content

Add "UseFullName" parameter to Update-MarkdownHelpModule #380

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 2 commits into from
Jul 10, 2018
Merged

Add "UseFullName" parameter to Update-MarkdownHelpModule #380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43f41ee
update updatemarkdownhelpmodule
Jul 9, 2018
617fada
update help file
Jul 9, 2018
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
18 changes: 17 additions & 1 deletion docs/Update-MarkdownHelpModule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ Update all files in a markdown help module folder.

```
Update-MarkdownHelpModule [-Path] <String[]> [[-Encoding] <Encoding>] [-RefreshModulePage]
[[-LogPath] <String>] [-LogAppend] [-AlphabeticParamsOrder] [-Session <PSSession>] [<CommonParameters>]
[[-LogPath] <String>] [-LogAppend] [-AlphabeticParamsOrder] [-UseFullTypeName] [-Session <PSSession>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -167,6 +168,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -UseFullTypeName
Indicates that the target document will use a full type name instead of a short name for parameters.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
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).

Expand Down
3 changes: 2 additions & 1 deletion src/platyPS/platyPS.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -561,6 +561,7 @@ function Update-MarkdownHelpModule
[string]$LogPath,
[switch]$LogAppend,
[switch]$AlphabeticParamsOrder,
[switch]$UseFullTypeName,

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

$allCommands = GetCommands -AsNames -Module $Module
Expand Down