Add documentation to types and fields

Fixes #3.
2021-04-21 18:07:36 -07:00
parent 32fea7fae4
commit 748f2cf072
26 changed files with 387 additions and 28 deletions
@@ -9,21 +9,31 @@ import (
 	"github.com/Khan/genqlient/graphql"
 )

+// getUserResponse is returned by getUser on success.
 type getUserResponse struct {
+	// Lookup a user by login.
 	User getUserUser `json:"user"`
 }

+// A user is an individual's account on GitHub that owns repositories and can make new content.
 type getUserUser struct {
-	TheirName string    `json:"theirName"`
+	// The user's public profile name.
+	TheirName string `json:"theirName"`
+	// Identifies the date and time when the object was created.
 	CreatedAt time.Time `json:"createdAt"`
 }

+// getViewerResponse is returned by getViewer on success.
 type getViewerResponse struct {
+	// The currently authenticated user.
 	Viewer getViewerViewerUser `json:"viewer"`
 }

+// A user is an individual's account on GitHub that owns repositories and can make new content.
 type getViewerViewerUser struct {
-	MyName    string    `json:"MyName"`
+	// The user's public profile name.
+	MyName string `json:"MyName"`
+	// Identifies the date and time when the object was created.
 	CreatedAt time.Time `json:"createdAt"`
 }