Fix Documentation Typo in Data/Sequence.hs (#541)
authorFrank Steffahn <fdsteffahn@gmail.com>
Fri, 9 Mar 2018 20:32:18 +0000 (21:32 +0100)
committerDavid Feuer <David.Feuer@gmail.com>
Fri, 9 Mar 2018 20:32:18 +0000 (15:32 -0500)
In the module header, in a code example where “index” is used infix, the back-ticks need to be escaped, otherwise haddock interprets them as (an alternative form of) quotes for a hyperlinked identifier which in particular makes the back-ticks invisible in the documentation and generates invalid Haskell code in the code example.

Data/Sequence.hs

index 8889242..863399b 100644 (file)
@@ -65,7 +65,7 @@
 --
 --     but
 --
---     @ (1 :<| undefined) `index` 0 = undefined @
+--     @ (1 :<| undefined) \`index\` 0 = undefined @
 --
 -- Sequences may also be compared to immutable
 -- [arrays](https://hackage.haskell.org/package/array)