Skip to content

Documentation small changes #263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The main features of GQL are:
* Supports [sync or async usage](https://gql.readthedocs.io/en/latest/async/index.html), [allowing concurrent requests](https://gql.readthedocs.io/en/latest/advanced/async_advanced_usage.html#async-advanced-usage)
* Supports [File uploads](https://gql.readthedocs.io/en/latest/usage/file_upload.html)
* Supports [Custom scalars / Enums](https://gql.readthedocs.io/en/latest/usage/custom_scalars_and_enums.html)
* [gql-cli script](https://gql.readthedocs.io/en/latest/gql-cli/intro.html) to execute GraphQL queries from the command line
* [gql-cli script](https://gql.readthedocs.io/en/latest/gql-cli/intro.html) to execute GraphQL queries or download schemas from the command line
* [DSL module](https://gql.readthedocs.io/en/latest/advanced/dsl_module.html) to compose GraphQL queries dynamically

## Installation
Expand Down
5 changes: 4 additions & 1 deletion docs/transports/phoenix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@
PhoenixChannelWebsocketsTransport
=================================

The PhoenixChannelWebsocketsTransport is an **EXPERIMENTAL** async transport which allows you
The PhoenixChannelWebsocketsTransport is an async transport which allows you
to execute queries and subscriptions against an `Absinthe`_ backend using the `Phoenix`_
framework `channels`_.

Reference:
:class:`gql.transport.phoenix_channel_websockets.PhoenixChannelWebsocketsTransport`

.. _Absinthe: http://absinthe-graphql.org
.. _Phoenix: https://www.phoenixframework.org
.. _channels: https://hexdocs.pm/phoenix/Phoenix.Channel.html#content
30 changes: 18 additions & 12 deletions gql/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -315,9 +315,10 @@ def _execute(
:param variable_values: Dictionary of input parameters.
:param operation_name: Name of the operation that shall be executed.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums. Default: False.
serialized. Used for custom scalars and/or enums.
By default use the serialize_variables argument of the client.
:param parse_result: Whether gql will unserialize the result.
By default use the parse_results attribute of the client.
By default use the parse_results argument of the client.

The extra arguments are passed to the transport execute method."""

Expand Down Expand Up @@ -378,9 +379,10 @@ def execute(
:param variable_values: Dictionary of input parameters.
:param operation_name: Name of the operation that shall be executed.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums. Default: False.
serialized. Used for custom scalars and/or enums.
By default use the serialize_variables argument of the client.
:param parse_result: Whether gql will unserialize the result.
By default use the parse_results attribute of the client.
By default use the parse_results argument of the client.
:param get_execution_result: return the full ExecutionResult instance instead of
only the "data" field. Necessary if you want to get the "extensions" field.

Expand Down Expand Up @@ -462,9 +464,10 @@ async def _subscribe(
:param variable_values: Dictionary of input parameters.
:param operation_name: Name of the operation that shall be executed.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums. Default: False.
serialized. Used for custom scalars and/or enums.
By default use the serialize_variables argument of the client.
:param parse_result: Whether gql will unserialize the result.
By default use the parse_results attribute of the client.
By default use the parse_results argument of the client.

The extra arguments are passed to the transport subscribe method."""

Expand Down Expand Up @@ -539,9 +542,10 @@ async def subscribe(
:param variable_values: Dictionary of input parameters.
:param operation_name: Name of the operation that shall be executed.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums. Default: False.
serialized. Used for custom scalars and/or enums.
By default use the serialize_variables argument of the client.
:param parse_result: Whether gql will unserialize the result.
By default use the parse_results attribute of the client.
By default use the parse_results argument of the client.
:param get_execution_result: yield the full ExecutionResult instance instead of
only the "data" field. Necessary if you want to get the "extensions" field.

Expand Down Expand Up @@ -598,9 +602,10 @@ async def _execute(
:param variable_values: Dictionary of input parameters.
:param operation_name: Name of the operation that shall be executed.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums. Default: False.
serialized. Used for custom scalars and/or enums.
By default use the serialize_variables argument of the client.
:param parse_result: Whether gql will unserialize the result.
By default use the parse_results attribute of the client.
By default use the parse_results argument of the client.

The extra arguments are passed to the transport execute method."""

Expand Down Expand Up @@ -665,9 +670,10 @@ async def execute(
:param variable_values: Dictionary of input parameters.
:param operation_name: Name of the operation that shall be executed.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums. Default: False.
serialized. Used for custom scalars and/or enums.
By default use the serialize_variables argument of the client.
:param parse_result: Whether gql will unserialize the result.
By default use the parse_results attribute of the client.
By default use the parse_results argument of the client.
:param get_execution_result: return the full ExecutionResult instance instead of
only the "data" field. Necessary if you want to get the "extensions" field.

Expand Down
2 changes: 1 addition & 1 deletion gql/transport/phoenix_channel_websockets.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def __init__(self, query_id: int) -> None:


class PhoenixChannelWebsocketsTransport(WebsocketsTransport):
"""The PhoenixChannelWebsocketsTransport is an **EXPERIMENTAL** async transport
"""The PhoenixChannelWebsocketsTransport is an async transport
which allows you to execute queries and subscriptions against an `Absinthe`_
backend using the `Phoenix`_ framework `channels`_.

Expand Down