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

Manually convert bulleted lists to Markdown #13046

Merged
merged 1 commit into from
Sep 10, 2015

Conversation

mbauman
Copy link
Member

@mbauman mbauman commented Sep 10, 2015

Bullet lists work just fine in Markdown right now, but it looks like the auto-converter didn't convert some. So I just manually converted them as I was browsing through the helpdb.

@mbauman mbauman added the docs This change adds or pertains to documentation label Sep 10, 2015
argument must be a command. Strings refer to filenames.
When called with more than two arguments, they are chained together from left to right.
For example ``pipeline(a,b,c)`` is equivalent to ``pipeline(pipeline(a,b),c)``. This provides a more
For example `pipeline(a,b,c)` is equivalent to `pipeline(pipeline(a,b),c)`. This provides a more
concise way to specify multi-stage pipelines.

**Examples**:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this rendered correctly with MarkDown?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, and it converts seamlessly back to RST, too. I think it's a GitHub flavor extension.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm running make -C doc and checked the html doc, on master it looks like
nacsctl-vs-office1

While on this branch it looks like:
nacsctl-vs-office1

The new version doesn't look too bad (honestly I prefer the new version) but this seems to be sth that markdown doesn't fully support (and / or not taken care of by the conversion code) and can introduce inconsistency in the html doc.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could use a header instead, but I think it's fine (I thought you were talking about the nested `backticks).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't look that bad.

jakebolewski added a commit that referenced this pull request Sep 10, 2015
Manually convert bulleted lists to Markdown
@jakebolewski jakebolewski merged commit 72c2ba1 into JuliaLang:master Sep 10, 2015
@mbauman mbauman deleted the bulletlists branch September 10, 2015 19:04
mbauman added a commit that referenced this pull request Sep 11, 2015
(cherry picked from commit daa95f1)
ref #13046
@tkelman
Copy link
Contributor

tkelman commented Sep 13, 2015

backported in #13072

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants