Standardize parameter names
Opened this issue · 0 comments
sdwheeler commented
Summary of the new feature / enhancement
Standardize parameter names to avoid type confusion
- Use CommandInfo and CommandHelp consistently
- For module parameters, need to distinguish between PSModuleInfo and ModuleFileInfo
- Should ModuleFile be a path rather than a ModuleFileInfo for Update-MarkdownModuleFile
Cmdlet Parameter Type
------ --------- ----
Export-MamlCommandHelp Command Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]
Export-MarkdownCommandHelp Command Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]
Export-YamlCommandHelp Command Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]
New-CommandHelp CommandInfo System.Management.Automation.CommandInfo[]
New-MarkdownCommandHelp Command System.Management.Automation.CommandInfo[]
New-MarkdownModuleFile CommandHelp Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]
Update-MarkdownModuleFile CommandHelp Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]
Export-MarkdownModuleFile ModuleFileInfo Microsoft.PowerShell.PlatyPS.ModuleFileInfo[]
Export-YamlModuleFile ModuleFile Microsoft.PowerShell.PlatyPS.ModuleFileInfo[]
New-MarkdownCommandHelp Module System.Management.Automation.PSModuleInfo[]
Update-MarkdownModuleFile ModuleFile Microsoft.PowerShell.PlatyPS.ModuleFileInfo
Proposed technical implementation details (optional)
No response