platyPS icon indicating copy to clipboard operation
platyPS copied to clipboard

Cmdlet Design Review notes

Open vors opened this issue 9 years ago • 2 comments

Notes from cmdlet design review

We did a review with @JamesWTruher @BrucePay @jongeller @joeyaiello @SteveL-MSFT

These items was not addressed in v0.4.0 release. I keeping them in a separate issue for future releases

  • [ ] Metadadta hashtable should validate types [string] of Key-Values
  • [ ] OnlineVersionUrl should be [uri] ?
  • [ ] NoMetada and Metadata should be in different parameter sets, even if that mean multiply syntaxes count
  • [ ] Get-HelpPreview should be a proxy function to Get-Help. It should support -Full -Example -Parameter, etc

Feel free to leave your feedback about cmdlets design

vors avatar May 23 '16 03:05 vors

@vors Is the Get-HelpPreview mentioned here related to #99 ?

BernieWhite avatar Dec 04 '17 04:12 BernieWhite

No, it's the existing one https://github.com/PowerShell/platyPS/blob/master/docs/Get-HelpPreview.md

I think it used to be called Show-HelpPreview originally and Jim suggested to change the verb as part of this design review meeting :)

vors avatar Dec 04 '17 06:12 vors

No longer applies. Microsoft.PowerShell.PlatyPS is a total redesign.

sdwheeler avatar May 24 '24 15:05 sdwheeler