eeva/servant
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add some missing comments in Servant.Docs.Internal

Browse source
This commit is contained in:
Nickolay Kudasov 2015-09-21 11:58:54 +03:00
parent 98af812491
commit 714e740098
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
servant-docs/src/Servant/Docs/Internal.hs
View file

@ -387,6 +387,7 @@ class ToSample a b | a -> b where
default toSamples :: (Generic a, Generic b, GToSample (Rep a) (Rep b)) => Proxy a -> [(Text, b)] default toSamples :: (Generic a, Generic b, GToSample (Rep a) (Rep b)) => Proxy a -> [(Text, b)]
toSamples = defaultSamples toSamples = defaultSamples
-- | Sample input or output (if there is at least one).
toSample :: forall a b. ToSample a b => Proxy a -> Maybe b toSample :: forall a b. ToSample a b => Proxy a -> Maybe b
toSample _ = snd <$> listToMaybe (toSamples (Proxy :: Proxy a)) toSample _ = snd <$> listToMaybe (toSamples (Proxy :: Proxy a))
@ -398,9 +399,13 @@ noSamples = empty
singleSample :: a -> [(Text, a)] singleSample :: a -> [(Text, a)]
singleSample x = [("", x)] singleSample x = [("", x)]
-- | Default sample Generic-based inputs/outputs.
defaultSamples :: forall a b. (Generic a, Generic b, GToSample (Rep a) (Rep b)) => Proxy a -> [(Text, b)] defaultSamples :: forall a b. (Generic a, Generic b, GToSample (Rep a) (Rep b)) => Proxy a -> [(Text, b)]
defaultSamples _ = Omega.runOmega $ second to <$> gtoSamples (Proxy :: Proxy (Rep a)) defaultSamples _ = Omega.runOmega $ second to <$> gtoSamples (Proxy :: Proxy (Rep a))
-- | @'ToSample'@ for Generics.
--
-- The use of @'Omega'@ allows for more productive sample generation.
class GToSample t s where class GToSample t s where
gtoSamples :: proxy t -> Omega.Omega (Text, s x) gtoSamples :: proxy t -> Omega.Omega (Text, s x)
@ -959,14 +964,12 @@ instance HasDocs sublayout => HasDocs (Vault :> sublayout) where
docsFor Proxy ep = docsFor Proxy ep =
docsFor (Proxy :: Proxy sublayout) ep docsFor (Proxy :: Proxy sublayout) ep
-- 'ToSample' instances for simple types -- ToSample instances for simple types
instance ToSample () () instance ToSample () ()
instance ToSample Bool Bool instance ToSample Bool Bool
instance ToSample Ordering Ordering instance ToSample Ordering Ordering
-- polymorphic 'ToSample' instances -- polymorphic ToSample instances
instance (ToSample a a, ToSample b b) => ToSample (a, b) (a, b) instance (ToSample a a, ToSample b b) => ToSample (a, b) (a, b)
instance (ToSample a a, ToSample b b, ToSample c c) => ToSample (a, b, c) (a, b, c) instance (ToSample a a, ToSample b b, ToSample c c) => ToSample (a, b, c) (a, b, c)
instance (ToSample a a, ToSample b b, ToSample c c, ToSample d d) => ToSample (a, b, c, d) (a, b, c, d) instance (ToSample a a, ToSample b b, ToSample c c, ToSample d d) => ToSample (a, b, c, d) (a, b, c, d)
@ -977,4 +980,3 @@ instance (ToSample a a, ToSample b b, ToSample c c, ToSample d d, ToSample e e,
instance ToSample a a => ToSample (Maybe a) (Maybe a) instance ToSample a a => ToSample (Maybe a) (Maybe a)
instance (ToSample a a, ToSample b b) => ToSample (Either a b) (Either a b) instance (ToSample a a, ToSample b b) => ToSample (Either a b) (Either a b)
instance ToSample a a => ToSample [a] [a] instance ToSample a a => ToSample [a] [a]