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

Fix bug in PlatyPS New-MarkdownHelp with multi-line param descriptions (?and example help maybe affected also?). #25

Open
IMJLA opened this issue Aug 20, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@IMJLA
Copy link
Owner

IMJLA commented Aug 20, 2022

When provided the same comment-based help as input, Get-Help respects the line breaks but New-MarkdownHelp does not.
New-MarkdownHelp generates an inaccurate markdown representation by converting multiple lines to a single line.
Declared as wontfix PowerShell/platyPS#314
Want to fix it myself and submit a PR
Until then, workaround is to include markdown syntax in PowerShell comment-based help
That is why there are so many extra blank lines and unordered lists in the commented metadata in this script

@IMJLA IMJLA added the enhancement New feature or request label Aug 20, 2022
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