update code documentation for utilities functions

Author: leszekhanusz

gql/utilities/parse_result.py

@@ -406,6 +406,13 @@ def parse_result(
 ) -> Optional[Dict[str, Any]]:
     """Unserialize a result received from a GraphQL backend.
 
+    :param schema: the GraphQL schema
+    :param document: the document representing the query sent to the backend
+    :param result: the serialized result received from the backend
+
+    :returns: a parsed result with scalars and enums parsed depending on
+              their definition in the schema.
+
     Given a schema, a query and a serialized result,
     provide a new result with parsed values.
 

gql/utilities/serialize_variable_values.py

@@ -53,7 +53,13 @@ def _get_document_operation(
 def serialize_value(type_: GraphQLType, value: Any) -> Any:
     """Given a GraphQL type and a Python value, return the serialized value.
 
+    This method will serialize the value recursively, entering into
+    lists and dicts.
+
     Can be used to serialize Enums and/or Custom Scalars in variable values.
+
+    :param type_: the GraphQL type
+    :param value: the provided value
     """
 
     if value is None:
@@ -93,7 +99,13 @@ def serialize_variable_values(
     """Given a GraphQL document and a schema, serialize the Dictionary of
     variable values.
 
-    Useful to serialize Enums and/or Custom Scalars in variable values
+    Useful to serialize Enums and/or Custom Scalars in variable values.
+
+    :param schema: the GraphQL schema
+    :param document: the document representing the query sent to the backend
+    :param variable_values: the dictionnary of variable values which needs
+        to be serialized.
+    :param operation_name: the optional operation_name for the query.
     """
 
     parsed_variable_values: Dict[str, Any] = {}

gql/utilities/update_schema_scalars.py

@@ -6,6 +6,10 @@
 def update_schema_scalar(schema: GraphQLSchema, name: str, scalar: GraphQLScalarType):
     """Update the scalar in a schema with the scalar provided.
 
+    :param schema: the GraphQL schema
+    :param name: the name of the custom scalar type in the schema
+    :param scalar: a provided scalar type
+
     This can be used to update the default Custom Scalar implementation
     when the schema has been provided from a text file or from introspection.
     """
@@ -35,8 +39,15 @@ def update_schema_scalar(schema: GraphQLSchema, name: str, scalar: GraphQLScalar
 def update_schema_scalars(schema: GraphQLSchema, scalars: List[GraphQLScalarType]):
     """Update the scalars in a schema with the scalars provided.
 
+    :param schema: the GraphQL schema
+    :param scalars: a list of provided scalar types
+
     This can be used to update the default Custom Scalar implementation
     when the schema has been provided from a text file or from introspection.
+
+    If the name of the provided scalar is different than the name of
+    the custom scalar, then you should use the
+    :func:`update_schema_scalar <gql.utilities.update_schema_scalar>` method instead.
     """
 
     if not isinstance(scalars, Iterable):