Parameter description is repeating in MAML xml twice

This forum can be browsed by the general public. Posting is limited to current SAPIEN license holders with active maintenance and does not offer a response time guarantee.
Forum rules
DO NOT POST LICENSE NUMBERS, ACTIVATION 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.

Any code longer than three lines should be added as code using the 'Select Code' dropdown menu or attached as a file.
This topic is 6 years and 11 months old and has exceeded the time allowed for comments. Please begin a new topic or use the search feature to find a similar but newer topic.
User avatar
gokulks
Posts: 6
Last visit: Thu Sep 06, 2018 11:28 pm

Parameter description is repeating in MAML xml twice

Post 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
User avatar
davidc
Posts: 5913
Last visit: Mon Jul 08, 2019 8:55 am
Been upvoted: 2 times

Re: Parameter description is repeating in MAML xml twice

Post 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.
David
SAPIEN Technologies, Inc.
This topic is 6 years and 11 months old and has exceeded the time allowed for comments. Please begin a new topic or use the search feature to find a similar but newer topic.