-
Notifications
You must be signed in to change notification settings - Fork 149
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
New Markdown Examples lack delimiter and padding #209
Comments
That's an interesting one. Also see #119 for the same discussion |
I'm leaning toward stripping delimiters from generated markdown and maybe adding them to maml. |
As long as the generated MAML has the right example headers I'd be fine with that. |
Also @cormacpayne pointed out that generated examples don't have extra padding line between them. |
@vors since example headers already create sections in markdown, I like the idea of keeping it "clean" and avoiding delimiters for markdown. However, I think that delimiters will look much better for MAML than a couple extra new lines after each example because it will clearly show when the next example starts. |
Closing as duplicate of #119 |
Steps to reproduce
Take any command that does not have comment based help. I created a tester
Then run New-MarkdownHelp for the command.
Expected behavior
I'm expecting an example heading like this:
-------------------------- EXAMPLE 1 --------------------------
Actual behavior
Example 1
Environment data
v0.7.0
The text was updated successfully, but these errors were encountered: