diff options
| author | Eugen Wissner <belka@caraus.de> | 2022-06-30 11:10:46 +0200 |
|---|---|---|
| committer | Eugen Wissner <belka@caraus.de> | 2022-06-30 11:10:46 +0200 |
| commit | 0dac9701bc3c1048d155d089167659ebcc152199 (patch) | |
| tree | 0ef97d6b5846727347af37df95e32366d42b9c53 /src/Language/GraphQL | |
| parent | 0d25f482dd33a71b93166b5fb0e6ac9de4a27eac (diff) | |
| download | graphql-0dac9701bc3c1048d155d089167659ebcc152199.tar.gz | |
Document usage of the json flag
Diffstat (limited to 'src/Language/GraphQL')
| -rw-r--r-- | src/Language/GraphQL/Error.hs | 12 | ||||
| -rw-r--r-- | src/Language/GraphQL/Execute/Coerce.hs | 5 |
2 files changed, 11 insertions, 6 deletions
diff --git a/src/Language/GraphQL/Error.hs b/src/Language/GraphQL/Error.hs index ffd3a78..403aaf6 100644 --- a/src/Language/GraphQL/Error.hs +++ b/src/Language/GraphQL/Error.hs @@ -103,8 +103,8 @@ instance Exception ResolverException -- | Runs the given query computation, but collects the errors into an error -- list, which is then sent back with the data. -- --- /runCollectErrs was part of the old executor and isn't used anymore, it will --- be deprecated in the future and removed./ +-- {-# DEPRECATED runCollectErrs was part of the old executor and isn't used +-- anymore #-} runCollectErrs :: (Monad m, Serialize a) => HashMap Name (Schema.Type m) -> CollectErrsT m a @@ -116,8 +116,8 @@ runCollectErrs types' res = do -- | Executor context. -- --- /Resolution was part of the old executor and isn't used anymore, it will be --- deprecated in the future and removed./ +-- {-# DEPRECATED Resolution was part of the old executor and isn't used +-- anymore #-} data Resolution m = Resolution { errors :: Seq Error , types :: HashMap Name (Schema.Type m) @@ -125,6 +125,6 @@ data Resolution m = Resolution -- | A wrapper to pass error messages around. -- --- /CollectErrsT was part of the old executor and isn't used anymore, it will be --- deprecated in the future and removed./ +-- {-# DEPRECATED CollectErrsT was part of the old executor and isn't used +-- anymore #-} type CollectErrsT m = StateT (Resolution m) m diff --git a/src/Language/GraphQL/Execute/Coerce.hs b/src/Language/GraphQL/Execute/Coerce.hs index 9bc6b10..4725d74 100644 --- a/src/Language/GraphQL/Execute/Coerce.hs +++ b/src/Language/GraphQL/Execute/Coerce.hs @@ -8,6 +8,11 @@ {-# LANGUAGE CPP #-} -- | Types and functions used for input and result coercion. +-- +-- JSON instances in this module are only available with the __json__ +-- flag that is currently on by default, but will be disabled in the future. +-- Refer to the documentation in the 'Language.GraphQL' module and to +-- the __graphql-spice__ package. module Language.GraphQL.Execute.Coerce ( Output(..) , Serialize(..) |