PowerShell / PowerShell/platyPS
`Import-Mamlhelp` loads only the first nodes in Inputs and Outputs.
Open
Nobody has claimed this yet.
Area-MAML
- Dominant language
- C#
- Stars
- 871
- Forks
- 166
- Avg merge
- 21h 17m
- Merged PRs (30d)
- 1
Description
Prerequisites
- Write a descriptive title.
- Make sure you are able to repro it on the latest version
- Search the existing issues.
Steps to reproduce
Two types are defined for Inputs and four for Outputs in Get-PSBreakpoint.
> $xml = [xml](Get-Content -Path ./test/Pester/assets/Microsoft.PowerShell.Commands.Utility.dll-Help.xml)
> $xml.DocumentElement.command.Where({ $_.details.name -eq "Get-PSBreakpoint" }).inputTypes.inputType.type.name
System.Int32
Microsoft.PowerShell.Commands.BreakpointType
> $xml.DocumentElement.command.Where({ $_.details.name -eq "Get-PSBreakpoint" }).returnValues.returnValue.type.name
System.Management.Automation.CommandBreakpoint
System.Management.Automation.LineBreakpoint
System.Management.Automation.VariableBreakpoint
System.Management.Automation.Breakpoint
However, Import-Mamlhelp loads only the first one each for Inputs and Outputs.
> $cmdHelps = Import-Mamlhelp -Path ./test/Pester/assets/Microsoft.PowerShell.Commands.Utility.dll-Help.xml
> $cmdHelps| ? Title -eq "Get-PSBreakpoint" | fl Title,Inputs,Outputs
Title : Get-PSBreakpoint
Inputs : {System.Int32}
Outputs : {System.Management.Automation.CommandBreakpoint}
Expected behavior
Title : Get-PSBreakpoint
Inputs : {System.Int32, Microsoft.PowerShell.Commands.BreakpointType}
Outputs : {System.Management.Automation.CommandBreakpoint, System.Management.Automation.LineBreakpoint, System.Management.Automation.VariableBreakpoint, System.Management.Automation.Breakpoint}
Actual behavior
Title : Get-PSBreakpoint
Inputs : {System.Int32}
Outputs : {System.Management.Automation.CommandBreakpoint}
Error details
None
Environment data
Name Value
---- -----
PSVersion 7.5.3
PSEdition Core
GitCommitId 7.5.3
OS Ubuntu 24.04.3 LTS
Platform Unix
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0
Version
1.0.1
Visuals
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the reproduction asset at test/Pester/assets/Microsoft.PowerShell.Commands.Utility.dll-Help.xml and run the Import-Mamlhelp example for Get-PSBreakpoint. Trace how its inputTypes and returnValues are read, then add regression coverage showing that every listed node is loaded. Done means Inputs contains both types and Outputs contains all four types shown in the expected behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, powershell
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100