Skip to content

Remove param value from md #729

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
Apr 24, 2025
Merged

Remove param value from md #729

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
921b664
Ignore parameterValue from Yaml serialization for markdown file
adityapatwardhan Apr 23, 2025
cc4f687
Add test to verify that parameterValue is removed from markdown
adityapatwardhan Apr 23, 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
2 changes: 2 additions & 0 deletions src/MarkdownReader/V2ParameterMetadata.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ public class ParameterMetadataV2
[YamlIgnore]
public bool VariableLength { get; set;}
public bool SupportsWildcards { get; set;}

[YamlIgnore]
public List<string> ParameterValue { get; set;}
public List<string> Aliases { get; set;}
public List<ParameterSetV2> ParameterSets { get; set; }
Expand Down
4 changes: 4 additions & 0 deletions test/Pester/ExportMarkdownCommandHelp.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,10 @@ Describe "Export-MarkdownCommandHelp" {
param ($number)
$ch.Parameters[$number] -eq $ch2.Parameters[$number] | Should -Be $true
}

It "Parameter yaml block should not have parameterValue" {
Get-Content "${outputFolder}/Get-Date.md" | Should -Not -Match "parameterValue"
}
}

Context "File Content - Input/Output" {
Expand Down