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
@@ -7,11 +7,16 @@ import (
 	"github.com/me/mypkg"
 )

+// A User is a user!
 type SimpleMutationCreateUser struct {
+	// id is the user's ID.
+	//
+	// It is stable, unique, and opaque, like all good IDs.
 	Id   mypkg.ID `json:"id"`
 	Name string   `json:"name"`
 }

+// SimpleMutationResponse is returned by SimpleMutation on success.
 type SimpleMutationResponse struct {
 	CreateUser SimpleMutationCreateUser `json:"createUser"`
 }