Skip to content

Commit

Permalink
doc: update the documentation to reflect changes made on output list …
Browse files Browse the repository at this point in the history
…coerce
  • Loading branch information
Maximilien-R committed Dec 8, 2020
1 parent b6f37d0 commit 2b544b1
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/api/engine.md
Expand Up @@ -80,6 +80,7 @@ The `create_engine` function provides an advanced interface for initialization.
* `query_cache_decorator` _(Optional[Callable])_: callable that will replace the tartiflette default lru_cache decorator to cache query parsing
* `json_loader` _(Optional[Callable[[str], Dict[str, Any]]])_: a Callable that will replace python built-in `json.loads` when Tartiflette will transform the json-ast of the query into a dict useable by the execution algorithm. ([more detail here](#parameter-json_loader))
* `custom_default_arguments_coercer` _(Optional[Callable])_: callable that will replace the tartiflette `default_arguments_coercer`
* `coerce_list_concurrently` _(Optional[bool])_: determine whether or not output list are coerced concurrently by default

#### Parameter: `error_coercer`

Expand Down Expand Up @@ -365,6 +366,7 @@ async def cook(
query_cache_decorator: Optional[Callable] = UNDEFINED_VALUE,
json_loader: Optional[Callable[[str], Dict[str, Any]]] = None,
custom_default_arguments_coercer: Optional[Callable] = None,
coerce_list_concurrently: Optional[bool] = None,
schema_name: str = None,
) -> None:
pass
Expand All @@ -378,4 +380,5 @@ async def cook(
* `query_cache_decorator` _(Optional[Callable])_: callable that will replace the tartiflette default lru_cache decorator to cache query parsing
* `json_loader` _(Optional[Callable[[str], Dict[str, Any]]])_: a Callable that will replace python built-in `json.loads` when Tartiflette will transform the json-ast of the query into a dict useable by the execution algorithm. ([more detail here](#parameter-json_loader))
* `custom_default_arguments_coercer` _(Optional[Callable])_: callable that will replace the tartiflette `default_arguments_coercer`
* `coerce_list_concurrently` _(Optional[bool])_: determine whether or not output list are coerced concurrently by default
* `schema_name` _(str = "default")_: name of the schema represented by the provided SDL ([more detail here](./schema-registry.md))
1 change: 1 addition & 0 deletions docs/api/resolver.md
Expand Up @@ -21,6 +21,7 @@ async def my_hello_resolver(parent, args, context, info):
* `schema_name` _(str = "default")_: name of the schema to which link the resolver
* `type_resolver` _(Optional[Callable] = None)_: the callable to use to resolve the type of an abstract type
* `arguments_coercer` _(Optional[Callable] = None)_: callable to use to coerce field arguments
* `concurrently` _(Optional[bool] = None)_: determine whether or not the output list of the decorated field should be coerced concurrently

The `arguments_coercer` parameter is here to provide an easy way to override the default callable used internaly by Tartiflette to coerce the arguments of the field. It has the same behaviour as the `custom_default_arguments_coercer` parameter at engine initialisation but impact only the field.

Expand Down
1 change: 1 addition & 0 deletions docs/api/subscription.md
Expand Up @@ -96,6 +96,7 @@ async def subscribe_subscription_launch_and_wait_cooking_timer(
* `name` _(str)_: fully qualified field name to resolve
* `schema_name` _(str = "default")_: name of the schema to which link the subscription
* `arguments_coercer` _(Optional[Callable] = None)_: callable to use to coerce field arguments
* `concurrently` _(Optional[bool] = None)_: determine whether or not the output list of the decorated field should be coerced concurrently

The `arguments_coercer` parameter is here to provide an easy way to override the default callable used internaly by Tartiflette to coerce the arguments of the field. It has the same behaviour as the `custom_default_arguments_coercer` parameter at engine initialisation but impact only the field.

Expand Down

0 comments on commit 2b544b1

Please sign in to comment.