[commit: haddock] alexbiehl-patch-1, ghc-8.0, ghc-head, ghc-head1, headdock-library-1.4.5, ie_avails, master, pr-filter-maps, pr/cabal-desc, travis, v2.17, v2.18, wip/T14529, wip/new-tree-one-param, wip/rae, wip/remove-frames, wip/remove-frames1, wip/revert-ttg-2017-11-20, wip/ttg-2017-10-13, wip/ttg-2017-10-31, wip/ttg-2017-11-06, wip/ttg2-2017-11-10, wip/ttg3-2017-11-12, wip/ttg4-constraints-2017-11-13, wip/ttg6-unrevert-2017-11-22: Add $ as a special character (d1dc783)

git at git.haskell.org git at git.haskell.org
Tue Nov 28 11:47:47 UTC 2017


Repository : ssh://git@git.haskell.org/haddock

On branches: alexbiehl-patch-1,ghc-8.0,ghc-head,ghc-head1,headdock-library-1.4.5,ie_avails,master,pr-filter-maps,pr/cabal-desc,travis,v2.17,v2.18,wip/T14529,wip/new-tree-one-param,wip/rae,wip/remove-frames,wip/remove-frames1,wip/revert-ttg-2017-11-20,wip/ttg-2017-10-13,wip/ttg-2017-10-31,wip/ttg-2017-11-06,wip/ttg2-2017-11-10,wip/ttg3-2017-11-12,wip/ttg4-constraints-2017-11-13,wip/ttg6-unrevert-2017-11-22
Link       : http://git.haskell.org/haddock.git/commitdiff/d1dc783cbf805e4169bf0528c57016ba175ad555

>---------------------------------------------------------------

commit d1dc783cbf805e4169bf0528c57016ba175ad555
Author: Omari Norman <omari at smileystation.com>
Date:   Wed Jun 29 21:59:34 2016 -0400

    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.


>---------------------------------------------------------------

d1dc783cbf805e4169bf0528c57016ba175ad555
 doc/markup.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/markup.rst b/doc/markup.rst
index 78718c1..b0ebc73 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 (``\\``).
 



More information about the ghc-commits mailing list