git.iko.soy/typeable/servant
on master help sign in
Various haddock fixes
da365b1Jan Hrček
servant/src/Servant/API/Description.hs+2−2
compare with master
unifiedsplit
@@ -39,14 +39,14 @@ data Summary (sym :: Symbol)
39--type MyApi = Description
39--type MyApi = Description
40-- "This comment is visible in multiple Servant interpretations \
40-- "This comment is visible in multiple Servant interpretations \
41-- \and can be really long if necessary. \
41-- \and can be really long if necessary. \
42−-- \Haskell multiline support is not perfect \
42+-- \Haskell multiline String support is not perfect \
43-- \but it's still very readable."
43-- \but it's still very readable."
44-- :> Get '[JSON] Book
44-- :> Get '[JSON] Book
45-- :}
45-- :}
46data Description (sym :: Symbol)
46data Description (sym :: Symbol)
47 deriving (Typeable)
47 deriving (Typeable)
48
48
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.
50--
50--
51-- >>> :kind! FoldDescription '[]
51-- >>> :kind! FoldDescription '[]
52-- FoldDescription '[] :: Symbol
52-- FoldDescription '[] :: Symbol
servant/src/Servant/API/Raw.hs+3−2
@@ -11,6 +11,7 @@ import Data.Typeable
11-- a modified (stripped) 'pathInfo' if the 'Application' is being routed with 'Servant.API.Sub.:>'.
11-- a modified (stripped) 'pathInfo' if the 'Application' is being routed with 'Servant.API.Sub.:>'.
12--
12--
13-- In addition to just letting you plug in your existing WAI 'Application's,
13-- In addition to just letting you plug in your existing WAI 'Application's,
14+-- this can also be used with functions from
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+-- <https://hackage.haskell.org/package/servant-server/docs/Servant-Server-StaticFiles.html Servant.Server.StaticFiles>
15−-- static files stored in a particular directory on your filesystem
16+-- to serve static files stored in a particular directory on your filesystem
16data Raw deriving Typeable
17data Raw deriving Typeable
servant/src/Servant/API/TypeLevel.hs+1−1
@@ -178,7 +178,7 @@ type family IsStrictSubAPI sub api :: Constraint where
178
178
179-- | Check that every element of @xs@ is an endpoint of @api@ (using @'IsIn'@).
179-- | Check that every element of @xs@ is an endpoint of @api@ (using @'IsIn'@).
180--
180--
181−-- ok (Proxy :: Proxy (AllIsIn (Endpoints SampleAPI) SampleAPI))
181+-- >>> ok (Proxy :: Proxy (AllIsIn (Endpoints SampleAPI) SampleAPI))
182-- OK
182-- OK
183type family AllIsIn xs api :: Constraint where
183type family AllIsIn xs api :: Constraint where
184 AllIsIn '[] api = ()
184 AllIsIn '[] api = ()