Document types and funcs

admin/client.go

@@ -6,6 +6,7 @@ import (
 	"github.com/writeas/go-ghost"
 )
 
+// Client wraps a ghost.Client.
 type Client struct {
 	ghost.Client
 }

admin/posts.go

@@ -7,6 +7,7 @@ import (
 	"net/http"
 )
 
+// AddPost creates a post from Markdown in the given ghost.PostParams.
 func AddPost(gc *ghost.Client, p ghost.PostParams) error {
 	c := getC(gc)
 

author.go

@@ -1,5 +1,6 @@
 package ghost
 
+// Author represents an author on Ghost.
 type Author struct {
 	ID              *string `json:"id"`
 	Name            *string `json:"name"`

error.go

@@ -1,5 +1,6 @@
 package ghost
 
+// Error represents an error returned from the Ghost API.
 type Error struct {
 	ID      *string `json:"id"`
 	Message *string `json:"message"`

ghost.go

@@ -14,6 +14,7 @@ import (
 	"time"
 )
 
+// Client stores the necessary values for interacting with the Ghost API.
 type Client struct {
 	URL       string
 	Key       string
@@ -26,7 +27,7 @@ type Client struct {
 // defaultHTTPTimeout is the default http.Client timeout.
 const defaultHTTPTimeout = 10 * time.Second
 
-// NewClient creates a new API client.
+// NewClient creates a new API Client.
 func NewClient(url, key string) *Client {
 	httpClient := &http.Client{Timeout: defaultHTTPTimeout}
 	return &Client{

post.go

@@ -5,6 +5,7 @@ import (
 )
 
 type (
+	// Post represents a post on Ghost.
 	Post struct {
 		ID                 *string   `json:"id"`
 		UUID               *string   `json:"uuid"`
@@ -34,6 +35,7 @@ type (
 		Excerpt            *string   `json:"excerpt"`
 	}
 
+	// PostParams are used for content publishing requests made to the Admin API.
 	PostParams struct {
 		Title     *string `json:"title"`
 		HTML      *string `json:"html,omitempty"`

tag.go

@@ -4,6 +4,7 @@ import (
 	"time"
 )
 
+// Tag represents a tag on Ghost.
 type Tag struct {
 	ID              *string   `json:"id"`
 	Name            *string   `json:"name"`