Bump haddock-library to 1.10.0 (#1598)

* Bump haddock-library to 1.10.0 * stack
haskell · Mar 20, 2021 · 7cb4ab7 · 7cb4ab7
1 parent aad6401
commit 7cb4ab7
Show file tree

Hide file tree

Showing 11 changed files with 18 additions and 6 deletions.
diff --git a/ghcide/ghcide.cabal b/ghcide/ghcide.cabal
@@ -55,7 +55,7 @@ library
         fingertree,
         ghc-exactprint,
         Glob,
-        haddock-library >= 1.8 && < 1.10,
+        haddock-library ^>= 1.10.0,
         hashable,
         hie-compat ^>= 0.1.0.0,
         hls-plugin-api ^>= 1.0.0.0,

diff --git a/ghcide/src/Development/IDE/Spans/Common.hs b/ghcide/src/Development/IDE/Spans/Common.hs
@@ -121,8 +121,15 @@ haddockToMarkdown (H.DocIdentifier i)
   = "`" ++ i ++ "`"
 haddockToMarkdown (H.DocIdentifierUnchecked i)
   = "`" ++ i ++ "`"
-haddockToMarkdown (H.DocModule i)
+haddockToMarkdown (H.DocModule (H.ModLink i Nothing))
   = "`" ++ escapeBackticks i ++ "`"
+-- See https://github.com/haskell/haddock/pull/1315
+-- Module references can be labeled in markdown style, e.g. [some label]("Some.Module")
+-- However, we don't want to use the link markup here, since the module name would be covered
+-- up by the label. Thus, we keep both the label and module name in the following style:
+-- some label ( `Some.Module` )
+haddockToMarkdown (H.DocModule (H.ModLink i (Just label)))
+  = haddockToMarkdown label ++ " ( `" ++ escapeBackticks i ++ "` )"
 haddockToMarkdown (H.DocWarning w)
   = haddockToMarkdown w
 haddockToMarkdown (H.DocEmphasis d)

diff --git a/stack-8.10.2.yaml b/stack-8.10.2.yaml
@@ -33,6 +33,7 @@ extra-deps:
   - lsp-1.1.1.0
   - lsp-types-1.1.0.0
   - lsp-test-0.13.0.0
+  - haddock-library-1.10.0
   - heapsize-0.3.0
   - hie-bios-0.7.4
   - implicit-hie-cradle-0.3.0.2

diff --git a/stack-8.10.3.yaml b/stack-8.10.3.yaml
@@ -28,6 +28,7 @@ extra-deps:
   - fourmolu-0.3.0.0
   - ghc-lib-8.10.4.20210206
   - ghc-lib-parser-8.10.4.20210206
+  - haddock-library-1.10.0
   - heapsize-0.3.0
   - hie-bios-0.7.4
   - implicit-hie-cradle-0.3.0.2

diff --git a/stack-8.10.4.yaml b/stack-8.10.4.yaml
@@ -26,6 +26,7 @@ extra-deps:
   - data-tree-print-0.1.0.2@rev:2
   - floskell-0.10.4
   - fourmolu-0.3.0.0
+  - haddock-library-1.10.0
   - heapsize-0.3.0
   - hie-bios-0.7.4
   - implicit-hie-cradle-0.3.0.2

diff --git a/stack-8.6.4.yaml b/stack-8.6.4.yaml
@@ -43,7 +43,7 @@ extra-deps:
   - ghc-source-gen-0.4.0.0
   - ghc-trace-events-0.1.2.1
   - haddock-api-2.22.0@rev:1
-  - haddock-library-1.8.0
+  - haddock-library-1.10.0
   - hashable-1.3.0.0
   - heapsize-0.3.0
   - hie-bios-0.7.4

diff --git a/stack-8.6.5.yaml b/stack-8.6.5.yaml
@@ -42,7 +42,7 @@ extra-deps:
   - ghc-source-gen-0.4.0.0
   - ghc-trace-events-0.1.2.1
   - haddock-api-2.22.0@rev:1
-  - haddock-library-1.8.0
+  - haddock-library-1.10.0
   - hashable-1.3.0.0
   - heapsize-0.3.0
   - hie-bios-0.7.4

diff --git a/stack-8.8.2.yaml b/stack-8.8.2.yaml
@@ -36,7 +36,7 @@ extra-deps:
   - ghc-lib-parser-8.10.4.20210206
   - ghc-lib-parser-ex-8.10.0.17
   - ghc-trace-events-0.1.2.1
-  - haddock-library-1.8.0
+  - haddock-library-1.10.0
   - haskell-src-exts-1.21.1
   - heapsize-0.3.0
   - hie-bios-0.7.4

diff --git a/stack-8.8.3.yaml b/stack-8.8.3.yaml
@@ -34,6 +34,7 @@ extra-deps:
   - ghc-lib-parser-8.10.4.20210206
   - ghc-trace-events-0.1.2.1
   - haskell-src-exts-1.21.1
+  - haddock-library-1.10.0
   - heapsize-0.3.0
   - hie-bios-0.7.4
   - hlint-3.2.3

diff --git a/stack-8.8.4.yaml b/stack-8.8.4.yaml
@@ -34,6 +34,7 @@ extra-deps:
   - ghc-lib-parser-8.10.4.20210206
   - ghc-trace-events-0.1.2.1
   - haskell-src-exts-1.21.1
+  - haddock-library-1.10.0
   - heapsize-0.3.0
   - hie-bios-0.7.4
   - hlint-3.2.3

diff --git a/stack.yaml b/stack.yaml
@@ -44,7 +44,7 @@ extra-deps:
   - ghc-source-gen-0.4.0.0
   - ghc-trace-events-0.1.2.1
   - haddock-api-2.22.0@rev:1
-  - haddock-library-1.8.0
+  - haddock-library-1.10.0
   - hashable-1.3.0.0
   - heapsize-0.3.0
   - hie-bios-0.7.4