Skip to content
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

Follow pascal casing on -AbbreviateParameterTypename parameter #715

Open
wants to merge 1 commit into
base: v2
Choose a base branch
from
Open

Follow pascal casing on -AbbreviateParameterTypename parameter #715

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 src/Command/NewMarkdownHelpCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public sealed class NewMarkdownHelpCommand : PSCmdlet
public SwitchParameter WithModulePage { get; set; }

[Parameter]
public SwitchParameter AbbreviateParameterTypename { get; set; }
public SwitchParameter AbbreviateParameterTypeName { get; set; }

#endregion

Expand Down Expand Up @@ -139,7 +139,7 @@ protected override void EndProcessing()
ModuleName = cmd.ModuleName is null ? string.Empty : cmd.ModuleName,
ModuleGuid = cmd.Module?.Guid is null ? Guid.Empty : cmd.Module.Guid,
OnlineVersionUrl = HelpUri,
UseFullTypeName = ! AbbreviateParameterTypename
UseFullTypeName = ! AbbreviateParameterTypeName
};

try
Expand Down
2 changes: 1 addition & 1 deletion test/Pester/NewMarkdownHelp.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,7 @@ Write-Host 'Hello World!'
$expectedParameterNames = "CCC","ddd","WhatIf"
$expectedParameterTypes = "String","Nullable``1[System.Int32]","SwitchParameter"
$expectedSyntax = 'Get-Alpha [[-CCC] <string>] [[-ddd] <int>] [-WhatIf] [<CommonParameters>]'
$file = New-MarkdownCommandHelp -Command (get-command Get-Alpha) -OutputFolder "$TestDrive/alpha" -Force -AbbreviateParameterTypename
$file = New-MarkdownCommandHelp -Command (get-command Get-Alpha) -OutputFolder "$TestDrive/alpha" -Force -AbbreviateParameterTypeName
$ch = Import-MarkdownCommandHelp $file
$ch.Parameters.Name | Should -Be $expectedParameterNames
$ch.Parameters.Type | Should -Be $expectedParameterTypes
Expand Down
4 changes: 2 additions & 2 deletions v2docs/Microsoft.PowerShell.PlatyPS/New-MarkdownCommandHelp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Creates Markdown help files for PowerShell modules and commands.
New-MarkdownCommandHelp -OutputFolder <string> [-CommandInfo <CommandInfo[]>] [-Encoding <Encoding>]
[-Force] [-HelpUri <string>] [-HelpInfoUri <string>] [-HelpVersion <version>] [-Locale <string>]
[-Metadata <hashtable>] [-ModuleInfo <psmoduleinfo[]>] [-WithModulePage]
[-AbbreviateParameterTypename] [-WhatIf] [-Confirm] [<CommonParameters>]
[-AbbreviateParameterTypeName] [-WhatIf] [-Confirm] [<CommonParameters>]
```

## ALIASES
Expand Down Expand Up @@ -61,7 +61,7 @@ New-MarkdownCommandHelp @newMarkdownCommandHelpSplat

## PARAMETERS

### -AbbreviateParameterTypename
### -AbbreviateParameterTypeName

By default, this command uses full type names in the parameter metadata and for the input and output
types. When you use this parameter, the cmdlet outputs short type names.
Expand Down
Loading