From da365b1e477282397857ab5ee36b3b15d2b7b3ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Hr=C4=8Dek?= Date: Tue, 12 Nov 2019 08:57:14 +0100 Subject: [PATCH] Various haddock fixes --- servant/src/Servant/API/Description.hs | 4 ++-- servant/src/Servant/API/Raw.hs | 5 +++-- servant/src/Servant/API/TypeLevel.hs | 2 +- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/servant/src/Servant/API/Description.hs b/servant/src/Servant/API/Description.hs index b7996650..18c54322 100644 --- a/servant/src/Servant/API/Description.hs +++ b/servant/src/Servant/API/Description.hs @@ -39,14 +39,14 @@ data Summary (sym :: Symbol) --type MyApi = Description -- "This comment is visible in multiple Servant interpretations \ -- \and can be really long if necessary. \ --- \Haskell multiline support is not perfect \ +-- \Haskell multiline String support is not perfect \ -- \but it's still very readable." -- :> Get '[JSON] Book -- :} data Description (sym :: Symbol) deriving (Typeable) --- | Fold modifier list to decide whether argument should be parsed strictly or leniently. +-- | Fold list of modifiers to extract description as a type-level String. -- -- >>> :kind! FoldDescription '[] -- FoldDescription '[] :: Symbol diff --git a/servant/src/Servant/API/Raw.hs b/servant/src/Servant/API/Raw.hs index 0624298c..4ece3845 100644 --- a/servant/src/Servant/API/Raw.hs +++ b/servant/src/Servant/API/Raw.hs @@ -11,6 +11,7 @@ import Data.Typeable -- a modified (stripped) 'pathInfo' if the 'Application' is being routed with 'Servant.API.Sub.:>'. -- -- In addition to just letting you plug in your existing WAI 'Application's, --- this can also be used with to serve --- static files stored in a particular directory on your filesystem +-- this can also be used with functions from +-- +-- to serve static files stored in a particular directory on your filesystem data Raw deriving Typeable diff --git a/servant/src/Servant/API/TypeLevel.hs b/servant/src/Servant/API/TypeLevel.hs index 188aa63d..79ff287a 100644 --- a/servant/src/Servant/API/TypeLevel.hs +++ b/servant/src/Servant/API/TypeLevel.hs @@ -178,7 +178,7 @@ type family IsStrictSubAPI sub api :: Constraint where -- | Check that every element of @xs@ is an endpoint of @api@ (using @'IsIn'@). -- --- ok (Proxy :: Proxy (AllIsIn (Endpoints SampleAPI) SampleAPI)) +-- >>> ok (Proxy :: Proxy (AllIsIn (Endpoints SampleAPI) SampleAPI)) -- OK type family AllIsIn xs api :: Constraint where AllIsIn '[] api = ()