Fix ambiguous haddock errors (#2014)

… and fix CI to catch them going forward

Author: Gabriella439

dhall/ghc-src/Dhall/Import/Manager.hs

@@ -1,10 +1,12 @@
-{-| Both the GHC and GHCJS implementations of "Dhall.Import.Manager" export a
-    `Manager` type suitable for use within the "Dhall.Import" module
+{-| Both the GHC and GHCJS implementations of 'Dhall.Import.Manager.Manager'
+    export a `Dhall.Import.Manager.Manager` type suitable for use within the
+    "Dhall.Import" module
 
-    For the GHC implementation the `Manager` type is a real `Manager` from the
-    @http-client@ package.  For the GHCJS implementation the `Manager` type is
-    a synonym for @`Data.Void.Void`@ since GHCJS does not use a `Manager` for
-    HTTP requests.
+    For the GHC implementation the `Dhall.Import.Manager` type is a real
+    `Network.HTTP.Client.Manager` from the @http-client@ package.  For the
+    GHCJS implementation the `Dhall.Import.Manager.Manager` type is
+    a synonym for @`Data.Void.Void`@ since GHCJS does not use a
+    `Network.HTTP.Client.Manager` for HTTP requests.
 -}
 module Dhall.Import.Manager
     ( -- * Manager

dhall/ghcjs-src/Dhall/Import/HTTP.hs

@@ -18,11 +18,11 @@ import qualified Data.Text      as Text
 import qualified JavaScript.XHR
 
 
-{-| The GHCJS implementation does not require a `Manager`
+{-| The GHCJS implementation does not require a `Network.HTTP.Client.Manager`
 
     The purpose of this synonym is so that "Dhall.Import.Types" can import a
-    `Manager` type from "Dhall.Import.HTTP" that does the correct thing for
-    both the GHC and GHCJS implementations
+    `Dhall.Import.Manager.Manager` type from "Dhall.Import.HTTP" that does the
+    correct thing for both the GHC and GHCJS implementations
 -}
 type Manager = Void
 

dhall/ghcjs-src/Dhall/Import/Manager.hs

@@ -1,10 +1,12 @@
-{-| Both the GHC and GHCJS implementations of "Dhall.Import.Manager" export a
-    `Manager` type suitable for use within the "Dhall.Import" module
+{-| Both the GHC and GHCJS implementations of `Dhall.Import.Manager.Manager`
+    export a `Dhall.Import.Manager.Manager` type suitable for use within the
+    "Dhall.Import" module
 
-    For the GHC implementation the `Manager` type is a real `Manager` from the
-    @http-client@ package.  For the GHCJS implementation the `Manager` type is
-    a synonym for @`Data.Void.Void`@ since GHCJS does not use a `Manager` for
-    HTTP requests.
+    For the GHC implementation the `Dhall.Import.Manager.Manager` type is a real
+    `Network.HTTP.Client.Manager` from the @http-client@ package.  For the GHCJS
+    implementation the `Dhall.Import.Manager.Manager` type is a synonym for
+    @`Data.Void.Void`@ since GHCJS does not use a
+    `Network.HTTP.Client.Manager` for HTTP requests.
 -}
 module Dhall.Import.Manager
     ( -- * Manager
@@ -13,5 +15,5 @@ module Dhall.Import.Manager
 
 import Data.Void (Void)
 
--- | GHCJS does not use a `Manager`
+-- | GHCJS does not use a `Network.HTTP.Client.Manager`
 type Manager = Void

dhall/src/Dhall.hs

@@ -41,7 +41,7 @@ module Dhall
     , InputSettings
     , defaultEvaluateSettings
     , EvaluateSettings
-    , HasEvaluateSettings
+    , HasEvaluateSettings(..)
     , detailed
 
     -- * Decoders
@@ -110,7 +110,7 @@ module Dhall
     , union
     , constructor
     , GenericFromDhall(..)
-
+    , GenericFromDhallUnion(..)
     , ToDhall(..)
     , Inject
     , inject
@@ -133,6 +133,7 @@ module Dhall
     , rawInput
     , (>$<)
     , (>*<)
+    , Result
 
     -- * Re-exports
     , Natural
@@ -259,7 +260,7 @@ typeError expected actual = Failure $ case expected of
     Failure e         -> fmap ExpectedTypeError e
     Success expected' -> DhallErrors $ pure $ TypeMismatch $ InvalidDecoder expected' actual
 
--- | Turn a `Text` message into an extraction failure
+-- | Turn a `Data.Text.Text` message into an extraction failure
 extractError :: Text -> Extractor s a b
 extractError = Failure . DhallErrors . pure . ExtractError
 
@@ -630,7 +631,7 @@ inputHelper annotate settings txt = do
 --   The intended use case is to allow easy extraction of Dhall values for
 --   making the function `Core.normalizeWith` easier to use.
 --
---   For other use cases, use `input` from `Dhall` module. It will give you
+--   For other use cases, use `input` from "Dhall" module. It will give you
 --   a much better user experience.
 rawInput
     :: Alternative f
@@ -785,7 +786,7 @@ data Decoder a = Decoder
     }
     deriving (Functor)
 
-{-| Decode a `Bool`
+{-| Decode a `Prelude.Bool`
 
 >>> input bool "True"
 True
@@ -798,7 +799,7 @@ bool = Decoder {..}
 
     expected = pure Bool
 
-{-| Decode a `Natural`
+{-| Decode a `Prelude.Natural`
 
 >>> input natural "42"
 42
@@ -811,7 +812,7 @@ natural = Decoder {..}
 
     expected = pure Natural
 
-{-| Decode an `Integer`
+{-| Decode an `Prelude.Integer`
 
 >>> input integer "+42"
 42
@@ -939,7 +940,7 @@ r
 scientific :: Decoder Scientific
 scientific = fmap Data.Scientific.fromFloatDigits double
 
-{-| Decode a `Double`
+{-| Decode a `Prelude.Double`
 
 >>> input double "42.0"
 42.0
@@ -952,15 +953,15 @@ double = Decoder {..}
 
     expected = pure Double
 
-{-| Decode lazy `Text`
+{-| Decode lazy `Data.Text.Text`
 
 >>> input lazyText "\"Test\""
 "Test"
 -}
 lazyText :: Decoder Data.Text.Lazy.Text
 lazyText = fmap Data.Text.Lazy.fromStrict strictText
 
-{-| Decode strict `Text`
+{-| Decode strict `Data.Text.Text`
 
 >>> input strictText "\"Test\""
 "Test"
@@ -1054,7 +1055,7 @@ functionWith inputNormalizer (Encoder {..}) (Decoder extractIn expectedIn) =
 
     expectedOut = Pi "_" declared <$> expectedIn
 
-{-| Decode a `Set` from a `List`
+{-| Decode a `Data.Set.Set` from a `List`
 
 >>> input (setIgnoringDuplicates natural) "[1, 2, 3]"
 fromList [1,2,3]
@@ -1068,7 +1069,7 @@ fromList [1,3]
 setIgnoringDuplicates :: (Ord a) => Decoder a -> Decoder (Data.Set.Set a)
 setIgnoringDuplicates = fmap Data.Set.fromList . list
 
-{-| Decode a `HashSet` from a `List`
+{-| Decode a `Data.HashSet.HashSet` from a `List`
 
 >>> input (hashSetIgnoringDuplicates natural) "[1, 2, 3]"
 fromList [1,2,3]
@@ -1084,7 +1085,7 @@ hashSetIgnoringDuplicates :: (Hashable a, Ord a)
                           -> Decoder (Data.HashSet.HashSet a)
 hashSetIgnoringDuplicates = fmap Data.HashSet.fromList . list
 
-{-| Decode a `Set` from a `List` with distinct elements
+{-| Decode a `Data.Set.Set` from a `List` with distinct elements
 
 >>> input (setFromDistinctList natural) "[1, 2, 3]"
 fromList [1,2,3]
@@ -1113,7 +1114,7 @@ An error is thrown if the list contains duplicates.
 setFromDistinctList :: (Ord a, Show a) => Decoder a -> Decoder (Data.Set.Set a)
 setFromDistinctList = setHelper Data.Set.size Data.Set.fromList
 
-{-| Decode a `HashSet` from a `List` with distinct elements
+{-| Decode a `Data.HashSet.HashSet` from a `List` with distinct elements
 
 >>> input (hashSetFromDistinctList natural) "[1, 2, 3]"
 fromList [1,2,3]
@@ -1683,6 +1684,9 @@ extractUnionConstructor (Field (Union kts) (Core.fieldSelectionLabel -> fld)) =
 extractUnionConstructor _ =
   empty
 
+{-| This is the underlying class that powers the `FromDhall` class's support
+    for automatically deriving a generic implementation for a union type
+-}
 class GenericFromDhallUnion t f where
     genericUnionAutoWithNormalizer :: Proxy t -> InputNormalizer -> InterpretOptions -> UnionDecoder (f a)
 

dhall/src/Dhall/Binary.hs

@@ -98,7 +98,7 @@ data StandardVersion
     -- ^ Version "1.0.0"
     deriving (Enum, Bounded)
 
--- | Render a `StandardVersion` as `Text`
+-- | Render a `StandardVersion` as `Data.Text.Text`
 renderStandardVersion :: StandardVersion -> Text
 renderStandardVersion NoVersion = "none"
 renderStandardVersion V_1_0_0   = "1.0.0"
@@ -1206,7 +1206,7 @@ instance Serialise (Expr Void Import) where
 encodeExpression :: Serialise (Expr Void a) => Expr Void a -> ByteString
 encodeExpression = Serialise.serialise
 
--- | Decode a Dhall expression from a CBOR `Term`
+-- | Decode a Dhall expression from a CBOR `Codec.CBOR.Term.Term`
 decodeExpression
     :: Serialise (Expr s a) => ByteString -> Either DecodingFailure (Expr s a)
 decodeExpression bytes =

dhall/src/Dhall/Context.hs

@@ -15,8 +15,8 @@ module Dhall.Context (
 import Data.Text (Text)
 import Prelude   hiding (lookup)
 
-{-| A @(Context a)@ associates `Text` labels with values of type @a@.  Each
-    `Text` label can correspond to multiple values of type @a@
+{-| A @(Context a)@ associates `Data.Text.Text` labels with values of type @a@.
+    Each `Data.Text.Text` label can correspond to multiple values of type @a@
 
     The `Context` is used for type-checking when @(a = Expr X)@
 

dhall/src/Dhall/Core.hs

@@ -99,7 +99,7 @@ pretty :: Pretty a => a -> Text
 pretty = pretty_
 {-# INLINE pretty #-}
 
-{-| Escape a `Text` literal using Dhall's escaping rules
+{-| Escape a `Data.Text.Text` literal using Dhall's escaping rules
 
     Note that the result does not include surrounding quotes
 -}
@@ -111,7 +111,7 @@ escapeText = escapeText_
 {-| Utility used to implement the @--censor@ flag, by:
 
     * Replacing all `Src` text with spaces
-    * Replacing all `Text` literals inside type errors with spaces
+    * Replacing all `Dhall.Syntax.Text` literals inside type errors with spaces
 -}
 censorExpression :: Expr Src a -> Expr Src a
 censorExpression (TextLit chunks) = TextLit (censorChunks chunks)
@@ -125,7 +125,9 @@ censorChunks (Chunks xys z) = Chunks xys' z'
 
     xys' = [ (censorText x, censorExpression y) | (x, y) <- xys ]
 
--- | Utility used to censor `Text` by replacing all characters with a space
+{-| Utility used to censor `Data.Text.Text` by replacing all characters with a
+    space
+-}
 censorText :: Text -> Text
 censorText = Data.Text.map (\_ -> ' ')
 

dhall/src/Dhall/Deriving.hs

@@ -58,7 +58,7 @@ module Dhall.Deriving
   , TrainCase
 
     -- * Type-level versions of SingletonConstructors
-  , ToSingletonConstructors
+  , ToSingletonConstructors(..)
   , Bare
   , Wrapped
   , Smart
@@ -402,7 +402,7 @@ instance FromDhall Font where
 
 Second, we defined the @Name@ type in Haskell as a newtype over @Text@, with a
 @getName@ field for unwrapping. In Dhall, however, @Name@ is a synonym of
-'Text', which is why 'input' above was expecting a record.
+'Data.Text.Text', which is why 'Dhall.input' above was expecting a record.
 The 'Dhall.Bare' option for 'singletonConstructors' is a perfect fit here:
 it translates Haskell singleton constructors into the Dhall version of the
 nested type, without wrapping it into a record.

dhall/src/Dhall/DirectoryTree.hs

@@ -137,8 +137,8 @@ toDirectoryTree path expression = case expression of
         unexpectedExpression = expression
 
 {- | This error indicates that you supplied an invalid Dhall expression to the
-     `directoryTree` function.  The Dhall expression could not be translated to
-     a directory tree.
+     `toDirectoryTree` function.  The Dhall expression could not be translated
+     to a directory tree.
 -}
 newtype FilesystemError =
     FilesystemError { unexpectedExpression :: Expr Void Void }

dhall/src/Dhall/Import.hs

@@ -130,6 +130,7 @@ module Dhall.Import (
     , chainImport
     , dependencyToFile
     , ImportSemantics
+    , HTTPHeader
     , Cycle(..)
     , ReferentiallyOpaque(..)
     , Imported(..)
@@ -345,6 +346,7 @@ instance Show MissingImports where
 throwMissingImport :: (MonadCatch m, Exception e) => e -> m a
 throwMissingImport e = throwM (MissingImports [toException e])
 
+-- | HTTP headers
 type HTTPHeader = (CI ByteString, ByteString)
 
 -- | Exception thrown when a HTTP url is imported but dhall was built without
@@ -498,9 +500,9 @@ chainImport (Chained parent) child =
     return (Chained (canonicalize (parent <> child)))
 
 -- | Load an import, resulting in a fully resolved, type-checked and normalised
---   expression. @loadImport@ handles the 'hot' cache in @Status@ and defers to
---   `loadImportWithSemanticCache` for imports that aren't in the @Status@ cache
---   already.
+--   expression. @loadImport@ handles the \"hot\" cache in @Status@ and defers
+--   to @loadImportWithSemanticCache@ for imports that aren't in the @Status@
+--   cache already.
 loadImport :: Chained -> StateT Status IO ImportSemantics
 loadImport import_ = do
     Status {..} <- State.get
@@ -513,7 +515,7 @@ loadImport import_ = do
             return importSemantics
 
 -- | Load an import from the 'semantic cache'. Defers to
---   `loadImportWithSemisemanticCache` for imports that aren't frozen (and
+--   @loadImportWithSemisemanticCache@ for imports that aren't frozen (and
 --   therefore not cached semantically), as well as those that aren't cached yet.
 loadImportWithSemanticCache :: Chained -> StateT Status IO ImportSemantics
 loadImportWithSemanticCache