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

Fix trailing whitespace in code literal #17939

Merged

Conversation

MichaelHatherly
Copy link
Member

rst apparently requires that the closing double backticks for code literals appear at the end of a "word", rather than preceded by a space as markdown allows. This means that julia> doesn't parse correctly. The fix is to just remove the trailing space and explicitly mention the need for a space after the >.

@MichaelHatherly MichaelHatherly added the domain:docs This change adds or pertains to documentation label Aug 10, 2016
@KristofferC
Copy link
Sponsor Member

KristofferC commented Aug 10, 2016

Thanks for updating my confusing entry.

@eschnett
Copy link
Contributor

Would a non-breaking space work?

@MichaelHatherly
Copy link
Member Author

Would a non-breaking space work?

Seems to work fine. Thanks.

@KristofferC
Copy link
Sponsor Member

KristofferC commented Aug 10, 2016

The NEWS.md entry is also broken. Maybe the same trick works there?

rst apparently requires that the closing double backticks for code literals
appear at the end of a "word", rather than preceded by a space as markdown
allows. This means that ``` ``julia> `` ``` doesn't parse correctly. The
fix is to just remove the trailing space and explicitly mention the need
for a space after the `>`.
@MichaelHatherly
Copy link
Member Author

Maybe the same trick works there?

It does appear to work with GitHub's markdown parser and Julia's as well.

@MichaelHatherly
Copy link
Member Author

Travis OSX error is unrelated, will merge shortly.

@MichaelHatherly MichaelHatherly merged commit 8cc4a9b into JuliaLang:master Aug 11, 2016
@MichaelHatherly MichaelHatherly deleted the mh/whitespace-literals branch August 11, 2016 07:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants