Example names normalization

[gerane]

I am just getting started with the Module, and have noticed differences between the way my Markdown files are getting set.

One module has examples like this

### Example 1

and the other has them like this

### -------------------------- EXAMPLE 1 --------------------------

Is there a way to control this that I am overlooking?

[vors]

If there are no examples, we generate a placeholder in the form of ### Example 1.
Otherwise, we preserve the original title of the Example from the existing help.

I think we would need some way to normalize it (on-demand or as default behavior?).
Great point!

[jongeller]

I think the placeholder format is more readable in the Markdown. However I wonder if this would present cleanly in MAML. If it does look good, I would vote for new example header styles.

[vors]

This issue been opened independently 3 times already, that really makes it the top request :)

[BernieWhite]

@vors The current observed behaviour of comment based help is to pad 26 * dash(-) either side of the Example nn. For single/double digit examples this results in a line 63/64 characters long. With an the same number of dashes each side of the text.

Based on that we currently allow more text then just Example nn i.e. ### Example 1: Create help from a command I would suggest that we stick with the 63/64 character for the length of the line rounded down do that the number of dashes is the same either side of the text.

The other points is that comment based help capitalises the EXAMPLE NN words. For consistency with comment based help it makes sense to do the same. What do you think?

Based on discussion from other duplicate issue, the intent is only to implement a change that will affect MAML output, and markdown editing of examples would remain unchanged.

Happy to pick this one up.

[vors]

I think capitalization is not necessary, the dashes provides enough visual clue. We can revisit it later based on the feedback.

Yes, please, go ahead!