diff options
| author | Omari Norman <omari@smileystation.com> | 2016-06-29 21:59:34 -0400 |
|---|---|---|
| committer | Omari Norman <omari@smileystation.com> | 2016-06-29 21:59:34 -0400 |
| commit | d1dc783cbf805e4169bf0528c57016ba175ad555 (patch) | |
| tree | 7cbec0d44ae2b98fb761defbbc92a5a26d5ddcaf /doc | |
| parent | 011c9e32d0449205e82479408dca2b4391e13fcf (diff) | |
Add $ as a special character
If this character is not escaped, documentation built with Haddock
2.17.2 will fail. This was not an issue with 2.16 series, which
causes builds to fail and there is nothing in the docs or error
message giving a clue about why builds that used to succeed now
don't.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/markup.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/markup.rst b/doc/markup.rst index 78718c18..b0ebc738 100644 --- a/doc/markup.rst +++ b/doc/markup.rst @@ -501,7 +501,7 @@ 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 (``\\``). |