doc(graphql): add documentation for a function

graphile · Oct 9, 2016 · 4b99a52 · 4b99a52
1 parent 2878b95
commit 4b99a52
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/graphql/schema/createGraphqlSchema.ts b/src/graphql/schema/createGraphqlSchema.ts
@@ -10,7 +10,9 @@ export type SchemaOptions = {
   nodeIdFieldName?: string,
 }
 
-// TODO: doc
+/**
+ * Creates a GraphQL schema using an instance of `Inventory`.
+ */
 export default function createGraphqlSchema (inventory: Inventory, options: SchemaOptions = {}): GraphQLSchema {
   // We take our user-friendly arguments to `createGraphqlSchema` and convert them
   // into a build token. One nice side effect of always creating our own