Skip to content

Do not append template if parameter description exists #783

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 3 commits into from
Jul 22, 2025
Merged

Do not append template if parameter description exists #783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3d502cc
Do not append template if parameter description exists
adityapatwardhan Jul 22, 2025
04e725a
Add tests
adityapatwardhan Jul 22, 2025
825ebc1
Update tests
adityapatwardhan Jul 22, 2025
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
5 changes: 4 additions & 1 deletion src/Common/MergeUtils.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,12 +246,15 @@ internal static bool TryGetMergedParameters(List<Parameter>fromHelp, List<Parame

var description = helpParam.Description;

var templateDescription = string.Format(Constants.FillInParameterDescriptionTemplate, helpParam.Name);

if (string.Equals(helpParam.Description, checkTemplate, StringComparison.OrdinalIgnoreCase))
{
diagnosticMessages.Add(new DiagnosticMessage(DiagnosticMessageSource.Merge, $"Parameter {pName} has no description in the help.", DiagnosticSeverity.Warning, "TryGetMergedParameters", -1));
description = cmdParam.Description;
}
else if (!string.Equals(helpParam.Description, cmdParam.Description, StringComparison.OrdinalIgnoreCase))
else if (!string.Equals(cmdParam.Description, templateDescription, StringComparison.OrdinalIgnoreCase)
&& !string.Equals(helpParam.Description, cmdParam.Description, StringComparison.OrdinalIgnoreCase))
{
diagnosticMessages.Add(new DiagnosticMessage(DiagnosticMessageSource.Merge, $"Parameter {pName} has the different description in the help and the command. Concatinating.", DiagnosticSeverity.Information, "TryGetMergedParameters", -1));
description = string.Join(Environment.NewLine, helpParam.Description, cmdParam.Description);
Expand Down
4 changes: 2 additions & 2 deletions test/Pester/MeasurePlatyPSMarkdown.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Describe "Export-MarkdownModuleFile" {

It "Should identify all the '<fileType>' assets" -TestCases @(
@{ fileType = "unknown"; expectedCount = 2 }
@{ fileType = "CommandHelp"; expectedCount = 41 }
@{ fileType = "CommandHelp"; expectedCount = 42 }
@{ fileType = "ModuleFile"; expectedCount = 16 }
@{ fileType = "V1Schema"; expectedCount = 52 }
@{ fileType = "V1Schema"; expectedCount = 53 }
@{ fileType = "V2Schema"; expectedCount = 5 }
) {
param ($fileType, $expectedCount)
Expand Down
5 changes: 5 additions & 0 deletions test/Pester/UpdateCommandHelp.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,11 @@ Describe "Tests for Update-CommandHelp" {
$ch.AliasHeaderFound | Should -Be $true
}

It "Should not append parameter descriptions with boiler plate if description is not boilerplate" {
$ch = Update-CommandHelp -Path ([io.path]::Combine($PSScriptRoot, "assets", "Export-Csv.md"))
$ch.Parameters.Where({$_.Name -eq "LiteralPath"}).Description | Should -Not -BeLike "*{{ Fill LiteralPath Description }}*"
}

Context "Parameter attribute updates" {
BeforeAll {
function test-update {
Expand Down
Loading