Skip to content

Commit b317672

Browse files
committed
fix: show source and result for all escape examples
Consolidate escape examples into a single code block with rendered output below, following the source/result pattern used elsewhere in the cheat sheet.
1 parent 30470b0 commit b317672

1 file changed

Lines changed: 9 additions & 10 deletions

File tree

Documentation/Basics/RstCheatSheet.rst

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -195,21 +195,20 @@ Escape characters
195195
If you want to use a character that would normally create reST markup,
196196
you must escape it with a prepended backslash (``\``).
197197

198-
For example, surrounding text with ``*`` normally makes it show up in italics.
199-
By escaping the ``*`` you make them normal text characters:
200-
201-
.. code-block:: rst
202-
203-
\*non-italic\*
204-
205-
Other common cases:
206-
207198
.. code-block:: rst
208199
200+
\*not italic\*
209201
\`not a text role\`
210-
\_not_a_reference
202+
\_not\_a\_reference
211203
\\literal backslash
212204
205+
Looks like this:
206+
207+
| \*not italic\*
208+
| \`not a text role\`
209+
| \_not\_a\_reference
210+
| \\literal backslash
211+
213212
.. note::
214213
Inside :ref:`code blocks <writing-rest-codeblocks-with-syntax-highlighting>`
215214
and inline code (backticks), escaping is not needed — content is displayed

0 commit comments

Comments
 (0)