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

New Markdown Examples lack delimiter and padding #209

Closed
jdhitsolutions opened this issue Sep 8, 2016 · 6 comments
Closed

New Markdown Examples lack delimiter and padding #209

jdhitsolutions opened this issue Sep 8, 2016 · 6 comments

Comments

@jdhitsolutions
Copy link

Steps to reproduce

Take any command that does not have comment based help. I created a tester

function Test-Me {
[cmdletbinding(SupportsShouldProcess)]
Param([string]$Name,[int32]$Size)
$name
$size
}

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

@vors
Copy link
Collaborator

vors commented Sep 8, 2016

That's an interesting one.
These delimiters are coming from the actual title in the maml-xmls.
In the core cmdlets, help consistently has them, but in other doesn't.
So it's more of the convention than the standard.

Also see #119 for the same discussion

@vors
Copy link
Collaborator

vors commented Sep 8, 2016

I'm leaning toward stripping delimiters from generated markdown and maybe adding them to maml.
There is no reason to have this delimiters in markdown, because headers already makes a section. Also it would help get a consistent view.

@jdhitsolutions
Copy link
Author

As long as the generated MAML has the right example headers I'd be fine with that.

@vors
Copy link
Collaborator

vors commented Sep 14, 2016

Also @cormacpayne pointed out that generated examples don't have extra padding line between them.
This is fixed per 15d62cb

@vors vors changed the title New Markdown Examples lack delimiter New Markdown Examples lack delimiter and padding Sep 14, 2016
@vors vors added this to the 0.7.1 milestone Sep 14, 2016
@vors vors self-assigned this Sep 14, 2016
@vors vors removed this from the 0.7.1 milestone Sep 17, 2016
@cormacpayne
Copy link

@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.

@vors vors removed their assignment Sep 7, 2017
@vors
Copy link
Collaborator

vors commented Dec 4, 2017

Closing as duplicate of #119

@vors vors closed this as completed Dec 4, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants