Merge pull request #832 from danpalmer/patch-6

Add basic type documentation for Relay fields

Author: syrusakbary

graphene/relay/connection.py

@@ -12,6 +12,12 @@
 
 
 class PageInfo(ObjectType):
+    class Meta:
+        description = (
+            "The Relay compliant `PageInfo` type, containing data necessary to"
+            " paginate this connection."
+        )
+
     has_next_page = Boolean(
         required=True,
         name="hasNextPage",
@@ -64,21 +70,40 @@ class EdgeBase(object):
             node = Field(_node, description="The item at the end of the edge")
             cursor = String(required=True, description="A cursor for use in pagination")
 
+        class EdgeMeta:
+            description = "A Relay edge containing a `{}` and its cursor.".format(
+                base_name
+            )
+
         edge_name = "{}Edge".format(base_name)
         if edge_class:
             edge_bases = (edge_class, EdgeBase, ObjectType)
         else:
             edge_bases = (EdgeBase, ObjectType)
 
-        edge = type(edge_name, edge_bases, {})
+        edge = type(edge_name, edge_bases, {"Meta": EdgeMeta})
         cls.Edge = edge
 
         options["name"] = name
         _meta.node = node
         _meta.fields = OrderedDict(
             [
-                ("page_info", Field(PageInfo, name="pageInfo", required=True)),
-                ("edges", Field(NonNull(List(edge)))),
+                (
+                    "page_info",
+                    Field(
+                        PageInfo,
+                        name="pageInfo",
+                        required=True,
+                        description="Pagination data for this connection.",
+                    ),
+                ),
+                (
+                    "edges",
+                    Field(
+                        NonNull(List(edge)),
+                        description="Contains the nodes in this connection.",
+                    ),
+                ),
             ]
         )
         return super(Connection, cls).__init_subclass_with_meta__(