Improve documentation for astFromValue (#2182)

graphql · Sep 17, 2019 · 06ef5db · 06ef5db
1 parent 1a82c35
commit 06ef5db
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/utilities/astFromValue.js b/src/utilities/astFromValue.js
@@ -24,7 +24,11 @@ import {
 } from '../type/definition';
 
 /**
- * Produces a GraphQL Value AST given a JavaScript value.
+ * Produces a GraphQL Value AST given a JavaScript object.
+ * Function will match JavaScript/JSON values to GraphQL AST schema format
+ * by using suggested GraphQLInputType. For example:
+ *
+ *     astFromValue("value", GraphQLString)
  *
  * A GraphQL type must be provided, which will be used to interpret different
  * JavaScript values.