HelpMessage of binary cmdlet
Steps to reproduce
in a c# cmdlet i define
[Parameter(HelpMessage = "aaaaaaaaaaaaaaaaaaa")]
public int ActivityId{ get; set; }
Expected behavior
I expect the module to understand my initial message "aaaaaaaaa"
Actual behavior
it render the usual
{{ Fill ActivityId Description }}
Environment data
I used a recompiled version of master
Name Value
PSVersion 5.1.17763.316 PSEdition Desktop PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...} BuildVersion 10.0.17763.316 CLRVersion 4.0.30319.42000 WSManStackVersion 3.0 PSRemotingProtocolVersion 2.3 SerializationVersion 1.1.0.1
This is not only for parameter description but for all help information in binary modules. I implemented it following this instruction (https://www.red-gate.com/simple-talk/dotnet/software-tools/documenting-your-powershell-binary-cmdlets/#third).
PlatyPS was not designed to use the help message attribute. The attribute is to prompt the user, which is not necessarily proper documentation for the parameter. But, I could argue that we may want to include this, so I'll mark for future consideration.
The HelpMessage for a parameter is now included in the parameter metadate in Microsoft.PowerShell.PlatyPS v1.