git.iko.soy/servant
on master help sign in
Merge pull request #1244 from jhrcek/docFixes

Various haddock fixes

commitcc7dc408d7b52262ac241ff7c70a91b562f620f5 authorOleg Grenrus <oleg.grenrus@iki.fi> dateFri 15 Nov 2019, 09:18 (7 years ago) parent1c4e3c4da365b1
3 files changed+6−5
compare with master
unifiedsplit
servant/src/Servant/API/Description.hs+2−2 servant/src/Servant/API/Raw.hs+3−2 servant/src/Servant/API/TypeLevel.hs+1−1
servant/src/Servant/API/Description.hs+2−2
@@ -39,14 +39,14 @@ data Summary (sym :: Symbol)
3939--type MyApi = Description
4040-- "This comment is visible in multiple Servant interpretations \
4141-- \and can be really long if necessary. \
42−-- \Haskell multiline support is not perfect \
42+-- \Haskell multiline String support is not perfect \
4343-- \but it's still very readable."
4444-- :> Get '[JSON] Book
4545-- :}
4646data Description (sym :: Symbol)
4747 deriving (Typeable)
4848
49−-- | Fold modifier list to decide whether argument should be parsed strictly or leniently.
49+-- | Fold list of modifiers to extract description as a type-level String.
5050--
5151-- >>> :kind! FoldDescription '[]
5252-- FoldDescription '[] :: Symbol
servant/src/Servant/API/Raw.hs+3−2
@@ -11,6 +11,7 @@ import Data.Typeable
1111-- a modified (stripped) 'pathInfo' if the 'Application' is being routed with 'Servant.API.Sub.:>'.
1212--
1313-- In addition to just letting you plug in your existing WAI 'Application's,
14−-- this can also be used with <https://hackage.haskell.org/package/servant-server/docs/Servant-Utils-StaticFiles.html#v:serveDirectory serveDirectory> to serve
15−-- static files stored in a particular directory on your filesystem
14+-- this can also be used with functions from
15+-- <https://hackage.haskell.org/package/servant-server/docs/Servant-Server-StaticFiles.html Servant.Server.StaticFiles>
16+-- to serve static files stored in a particular directory on your filesystem
1617data Raw deriving Typeable
servant/src/Servant/API/TypeLevel.hs+1−1
@@ -178,7 +178,7 @@ type family IsStrictSubAPI sub api :: Constraint where
178178
179179-- | Check that every element of @xs@ is an endpoint of @api@ (using @'IsIn'@).
180180--
181−-- ok (Proxy :: Proxy (AllIsIn (Endpoints SampleAPI) SampleAPI))
181+-- >>> ok (Proxy :: Proxy (AllIsIn (Endpoints SampleAPI) SampleAPI))
182182-- OK
183183type family AllIsIn xs api :: Constraint where
184184 AllIsIn '[] api = ()