diff options
| author | Noel Bourke <undergroundquizscene@gmail.com> | 2018-08-21 08:34:18 +0100 |
|---|---|---|
| committer | Alexander Biehl <alexbiehl@gmail.com> | 2018-08-21 09:34:18 +0200 |
| commit | 9712d8899d452292913a260058a6dd3346e8d39b (patch) | |
| tree | 981fbb9000d916e4bd1acfb7c5c59641d5823f49 /doc/markup.rst | |
| parent | 1c4076328cfdd3aadbbbd494a240e25bd7309b0c (diff) | |
Remove unnecessary backslashes from docs (#908)
On
https://haskell-haddock.readthedocs.io/en/latest/markup.html#special-characters
the backslash and backtick special characters showed up with an extra
backslash before them – I think the escaping is not (or no longer)
needed for those characters in rst.
Diffstat (limited to 'doc/markup.rst')
| -rw-r--r-- | doc/markup.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/markup.rst b/doc/markup.rst index e22c25e7..edbd45b2 100644 --- a/doc/markup.rst +++ b/doc/markup.rst @@ -762,14 +762,14 @@ Special Characters ~~~~~~~~~~~~~~~~~~ The following characters have special meanings in documentation -comments: ``\\``, ``/``, ``'``, ``\```, ``"``, ``@``, ``<``, ``$``, ``#``. To insert a +comments: ``\``, ``/``, ``'``, `````, ``"``, ``@``, ``<``, ``$``, ``#``. To insert a literal occurrence of one of these special characters, precede it with a -backslash (``\\``). +backslash (``\``). Additionally, the character ``>`` has a special meaning at the beginning of a line, and the following characters have special meanings at the beginning of a paragraph: ``*``, ``-``. These characters can also be -escaped using ``\\``. +escaped using ``\``. Furthermore, the character sequence ``>>>`` has a special meaning at the beginning of a line. To escape it, just prefix the characters in the |