Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Leverage Update-Markdownhelp when generating docs #32

Open
TsekNet opened this issue Sep 8, 2020 · 0 comments
Open

Leverage Update-Markdownhelp when generating docs #32

TsekNet opened this issue Sep 8, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@TsekNet
Copy link
Contributor

TsekNet commented Sep 8, 2020

Description

This is more of a nit FR, but it would be performant to leverage the platyPS Update-MarkdownHelp function over the New-MarkdownHelp function when generating documentation.

Update-MarkdownHelp doc: https://github.com/PowerShell/platyPS/blob/master/docs/Update-MarkdownHelp.md
New-MarkdownHelp doc: https://github.com/PowerShell/platyPS/blob/master/docs/New-MarkdownHelp.md

Describe the solution you'd like

If the doc already exists for a given function, leverage Update-MarkdownHelp function over the New-MarkdownHelp function. This can be done with a PowerShell foreach loop and nested conditional.

Describe any alternatives you've considered

New-Markdownhelp technically works, but it seems unnecessary to generate entirely new documentation files every time this module is built, especially if the function(s) have not been updated.

Additional context

See platyPS module documentation here: https://github.com/PowerShell/platyPS

@TsekNet TsekNet added the enhancement New feature or request label Sep 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant