graphql-python/graphene-django
1
1
Fork 0
mirror of https://github.com/graphql-python/graphene-django.git synced 2025-07-18 12:12:41 +03:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup RST warnings, minor rewordings

Browse Source
This commit is contained in:
Eric Abruzzese 2020-07-11 20:08:08 -04:00
parent a65b2a6df9
commit de1b7b8651
3 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/index.rst
View File

@ -28,6 +28,7 @@ For more advanced use, check out the Relay tutorial.
fields fields
extra-types extra-types
mutations mutations
subscriptions
filtering filtering
authorization authorization
debug debug

7
docs/settings.rst
View File

@ -104,7 +104,7 @@ Default: ``100``
``CAMELCASE_ERRORS`` ``CAMELCASE_ERRORS``
------------------------------------ --------------------
When set to ``True`` field names in the ``errors`` object will be camel case. When set to ``True`` field names in the ``errors`` object will be camel case.
By default they will be snake case. By default they will be snake case.
@ -151,7 +151,7 @@ Default: ``False``
``DJANGO_CHOICE_FIELD_ENUM_CUSTOM_NAME`` ``DJANGO_CHOICE_FIELD_ENUM_CUSTOM_NAME``
-------------------------------------- ----------------------------------------
Define the path of a function that takes the Django choice field and returns a string to completely customise the naming for the Enum type. Define the path of a function that takes the Django choice field and returns a string to completely customise the naming for the Enum type.
@ -173,7 +173,7 @@ Default: ``None``
``SUBSCRIPTION_PATH`` ``SUBSCRIPTION_PATH``
-------------------------------------- ---------------------
Define an alternative URL path where subscription operations should be routed. Define an alternative URL path where subscription operations should be routed.
@ -182,6 +182,7 @@ The GraphiQL interface will use this setting to intelligently route subscription
Default: ``None`` Default: ``None``
.. code:: python .. code:: python
GRAPHENE = { GRAPHENE = {
'SUBSCRIPTION_PATH': "/ws/graphql" 'SUBSCRIPTION_PATH': "/ws/graphql"
} }

8
docs/subscriptions.rst
View File

@ -1,9 +1,9 @@
Subscription Support Subscriptions
==================== =============
The ``graphene-django`` project does not currently support GraphQL subscriptions out of the box. However, there are The ``graphene-django`` project does not currently support GraphQL subscriptions out of the box. However, there are
several community-driven modules for adding subscription support, and the GraphiQL interface provided by several community-driven modules for adding subscription support, and the provided GraphiQL interface supports
``graphene-django`` supports subscriptions over websockets. running subscription operations over a websocket.
To implement websocket-based support for GraphQL subscriptions, you’ll need to do the following: To implement websocket-based support for GraphQL subscriptions, you’ll need to do the following: