Merge pull request #56 from tomhoule/copy-docs

Copy doc strings from schema to generated types

Author: tomhoule

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+### Added
+
+- Copy documentation from the GraphQL schema to the generated types (including their fields) as normal Rust documentation. Documentation will show up in the generated docs as well as IDEs that support expanding derive macros (which does not include the RLS yet).
+
 ## [0.1.0] - 2018-07-04
 
 This is the initial public release in which the library is considered usable.

examples/example_module/src/lib.rs

@@ -6,6 +6,7 @@ extern crate graphql_client;
 
 #[derive(GraphQLQuery)]
 #[graphql(
-    schema_path = "../github/src/schema.graphql", query_path = "../github/src/query_1.graphql"
+    schema_path = "../github/src/schema.graphql",
+    query_path = "../github/src/query_1.graphql"
 )]
 pub struct ExampleModule;

examples/github/src/main.rs

@@ -18,7 +18,10 @@ use graphql_client::*;
 use structopt::StructOpt;
 
 #[derive(GraphQLQuery)]
-#[graphql(schema_path = "src/schema.graphql", query_path = "src/query_1.graphql")]
+#[graphql(
+    schema_path = "src/schema.graphql",
+    query_path = "src/query_1.graphql"
+)]
 struct Query1;
 
 #[derive(StructOpt)]