Parameter description is repeating in MAML xml twice

Support for all customers who have purchased a PowerShell HelpWriter product license. This forum does not offer a response time guarantee.
Forum rules
DO NOT POST SUBSCRIPTION NUMBERS, LICENSE KEYS OR ANY OTHER LICENSING INFORMATION IN THIS FORUM.
Only the original author and our tech personnel can reply to a topic that is created in this forum. If you find a topic that relates to an issue you are having, please create a new topic and reference the other in your post.
User avatar
gokulks
Posts: 3
Joined: Fri Mar 24, 2017 1:59 am

Parameter description is repeating in MAML xml twice

Post by gokulks » Mon Apr 03, 2017 3:24 am

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

User avatar
davidc
Posts: 4979
Joined: Thu Aug 18, 2011 4:56 am

Re: Parameter description is repeating in MAML xml twice

Post by davidc » Mon Apr 03, 2017 8:07 am

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.
David
SAPIEN Technologies, Inc.