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

Round tripping strips spaces when it strips bold or italics #130

Closed
TimShererAtAquent opened this issue Jun 8, 2016 · 4 comments
Closed
Assignees
Milestone

Comments

@TimShererAtAquent
Copy link

Locally, I edited an .md file, doing the kind of writing we would do for a cmdlet. This is part of creating our round tripping procedures.

When I added bold or italics and then round tripped, the markup was gone, but so was the space before and after the marked word. (Using screen caps here so as not to confuse the markdown in this issue editor:)

bold before round trip
bold after round trip
emphasis before round trip
emphasis after round trip

Although it would be nice to have a way to maintain formatting through the round trip process, even if we don't do that, some contributors will use formatting anyway (since it is allowed and expected in markdown) so we can't have spaces disappearing.

@vors
Copy link
Collaborator

vors commented Jun 8, 2016

What exactly do you mean by round trip?
If you are talking about Markdown -> Maml -> Markdown, then it's expected, and nothing we can do about it. Maml schema doesn't allow us store all the things we want to store (i.e. parameter set names).

But that's not the suggested workflow.

Suggested workflow is: keep source of truth in Markdown. Use Update-MarkdownHelp to update it. Generate MAML as a build step and don't store it anywhere.

@TimShererAtAquent
Copy link
Author

There is still a problem, though. These screen caps are from my locally created maml file. The spaces are missing from the maml:
bold in maml
italics in maml

@vors
Copy link
Collaborator

vors commented Jun 8, 2016

good catch!

@vors vors added the bug label Jun 8, 2016
@vors vors self-assigned this Jun 8, 2016
@vors vors added this to the 0.5.0 milestone Jun 8, 2016
@vors
Copy link
Collaborator

vors commented Jun 10, 2016

Fixed in 3f25d00

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

2 participants