Page 1 of 1

Parameter description is repeating in MAML xml twice

Posted: Mon Apr 03, 2017 3:24 am
by gokulks
Product, version and build: PowerShell HelpWriter 2017 v2.1.34
(*** Please do not write "latest" as a version, specify a version number ***)
32 or 64 bit version of product: 64-bit
Operating system: Windows 10
32 or 64 bit OS: 64-bit OS

DO NOT POST SUBSCRIPTIONS, KEYS OR ANY OTHER LICENSING INFORMATION IN THIS FORUM

Whenever HelpWriter tool generates help mamal from the module it always adds parameter description under two locations.
>> One inside SyntaxItems xml tag (<command:syntaxItem> )
>> Another inside Parameters xml tag (<command:parameter> )

Actually in PowerShell help output it considers only later (Parameter xml tag ) content only not the first one.

So question is why is SAPIENT tool putting duplicate content in both the places. Why can't they remove the SyntaxItem content as PS help does not use it.
If i am missing anything let me know.

Thanks,
Gokul

Re: Parameter description is repeating in MAML xml twice

Posted: Mon Apr 03, 2017 8:07 am
by davidc
PowerShell HelpWriter follows Microsoft's specification /schema, which defines that both entries should have a description; therefore, we include it.
Note: This wouldn't be the first time Microsoft doesn't follow their own specifications.