search

PowerShell / platyPS

Write PowerShell External Help in Markdown
MIT License
782 stars 155 forks source link

Testing feedback for Update-MarkdownModuleFile #672

Closed sdwheeler closed 2 months ago

sdwheeler commented 3 months ago

Summary of the new feature / enhancement

  1. In PlatyPS build https://github.com/PowerShell/platyPS/commit/27d5ffe4090f146b64c7d91453d6683c68c8ee53, Update-MarkdownModuleFile doesn't create .bak files like Update-MarkdownCommandHelp does. Should it?
  2. The -ModuleFile parameter takes a ModuleFileInfo object, which requires you to import a markdown file. Should it take a PSModuleInfo object (like from Get-Module)?
    • Can we assume that it is in the -OutputFolder location?
    • Should this be a path-type parameter that points to the file to be updated?
  3. Add -Confirm and -WhatIf 4. Remove -HelpUri (not relevant to command)

I am open to further discussion.

Proposed technical implementation details (optional)

No response

sdwheeler commented 2 months ago

Items 1-3 fixed in OPS10.

Still need to remove -HelpUri - tracked in #670