Docs for triple-backticks and escaping backticks #4369
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GeoffreyBooth
force-pushed
the
backticks-docs
branch
from
3831536 to
f916abe
Compare
Merged
GeoffreyBooth
force-pushed
the
backticks-docs
branch
from
f916abe to
8a8d76f
Compare
GeoffreyBooth
changed the title
lydell
reviewed
Nov 22, 2016
| <%= codeFor('embedded_escaped', 'markdown()') %> | ||
| <p> | ||
| You can embed blocks of JavaScript using triple backticks. Within triple-backtick | ||
| blocks, single backticks are ignored. |
There was a problem hiding this comment.
Within triple-backtick blocks, single backticks are ignored.
That sentence stood out a bit to me while first reading it. "Ignored – how? What exactly does that mean?" Then, I realized that the sentence probably exists to tell that it is a better idea to use triple-backticks than to escape backticks inside single-backtick blocks. If that's the case, perhaps change this paragraph to something like this:
You can also embed blocks of JavaScript using triple backticks. That's easier than escaping backticks, if you need them inside your JavaScript block.
There was a problem hiding this comment.
Yes, that would be an improvement.
|
Sure. How about now? |
lydell
approved these changes
Nov 23, 2016
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation for #4357. Demonstrates the new triple-backtick syntax, and how to escape backticks and escaped escaped backticks.