PowerShell / platyPS

Write PowerShell External Help in Markdown
MIT License
765 stars 149 forks source link

Update the YAML schema #575

Closed adityapatwardhan closed 1 year ago

adityapatwardhan commented 2 years ago

PR Summary

Updated the schema as per the discussion

PR Context

xmdanni commented 2 years ago

parameterItems' properties:

adityapatwardhan commented 2 years ago
  1. I removed the summary property.
  2. Are you sure parameterValueGroup is used for accepted values? From the link you provided I could not infer that.
  3. valueFrom seems like it is accepted values. Example: Authentication parameter here: https://docs.microsoft.com/en-us/powershell/module/cimcmdlets/new-cimsession?view=powershell-7.2#parameters
sdwheeler commented 2 years ago

@adityapatwardhan

  • parameterValueGroup

I tested this and it is the accepted values. I can't find anything that uses valueFrom.

adityapatwardhan commented 2 years ago

I am pushing a change to remove summary and valueFrom. We added parameterSetName to capture the string which has the list of parameter sets the parameter belongs to.