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.hs | |
| parent | 0d25f482dd33a71b93166b5fb0e6ac9de4a27eac (diff) | |
| download | graphql-0dac9701bc3c1048d155d089167659ebcc152199.tar.gz | |
Document usage of the json flag
Diffstat (limited to 'src/Language/GraphQL.hs')
| -rw-r--r-- | src/Language/GraphQL.hs | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/src/Language/GraphQL.hs b/src/Language/GraphQL.hs index b64cf42..d54ae60 100644 --- a/src/Language/GraphQL.hs +++ b/src/Language/GraphQL.hs @@ -4,6 +4,28 @@ #ifdef WITH_JSON -- | This module provides the functions to parse and execute @GraphQL@ queries. +-- +-- The content of this module depends on the value of the __json__ flag, which +-- is currently on by default. This behavior will change in the future, the flag +-- will be switched off by default and then removed. +-- +-- This documentation is generated with the enabled __json__ flag and functions +-- described here support JSON and are deprecated. JSON instances are provided +-- now by an additional package, __graphql-spice__. To start using the new +-- package create __cabal.project__ in the root directory of your project with +-- the following contents: +-- +-- @ +-- packages: . +-- constraints: graphql -json +-- @ +-- +-- Then add __graphql-spice__ as dependency. +-- +-- The new version of this module defines only one function, @graphql@, which +-- works with the internal GraphQL value representation used by this lbirary. +-- Refer to @Language.GraphQL.JSON.graphql@ in __graphql-spice__ for the +-- function that accepts and returns JSON. module Language.GraphQL ( graphql , graphqlSubs |