From 15e10296a62b016cfc9c51b713bc2177742b5c58 Mon Sep 17 00:00:00 2001
From: Matt Baer <matt@flashstuf.com>
Date: Fri, 9 Sep 2016 00:11:22 -0400
Subject: [PATCH] Fix and add comments

---
 post.go    | 11 ++++++++++-
 writeas.go |  9 +++++++++
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/post.go b/post.go
index 5ebb575..450084b 100644
--- a/post.go
+++ b/post.go
@@ -30,7 +30,7 @@ type (
 
 	// PostParams holds values for creating or updating a post.
 	PostParams struct {
-		// Parameters only for creating
+		// Parameters only for updating
 		ID    string `json:"-"`
 		Token string `json:"token,omitempty"`
 
@@ -45,6 +45,9 @@ type (
 	}
 )
 
+// GetPost retrieves a published post, returning the Post and any error (in
+// user-friendly form) that occurs. See
+// https://writeas.github.io/docs/#retrieve-a-post.
 func (c *Client) GetPost(id string) (*Post, error) {
 	p := &Post{}
 	env, err := c.get(fmt.Sprintf("/posts/%s", id), p)
@@ -70,6 +73,8 @@ func (c *Client) GetPost(id string) (*Post, error) {
 	return p, nil
 }
 
+// CreatePost publishes a new post, returning a user-friendly error if one comes
+// up. See https://writeas.github.io/docs/#publish-a-post.
 func (c *Client) CreatePost(sp *PostParams) (*Post, error) {
 	p := &Post{}
 	env, err := c.post("/posts", sp, p)
@@ -93,6 +98,8 @@ func (c *Client) CreatePost(sp *PostParams) (*Post, error) {
 	return p, nil
 }
 
+// UpdatePost updates a published post with the given PostParams. See
+// https://writeas.github.io/docs/#update-a-post.
 func (c *Client) UpdatePost(sp *PostParams) (*Post, error) {
 	p := &Post{}
 	env, err := c.put(fmt.Sprintf("/posts/%s", sp.ID), sp, p)
@@ -118,6 +125,8 @@ func (c *Client) UpdatePost(sp *PostParams) (*Post, error) {
 	return p, nil
 }
 
+// DeletePost permanently deletes a published post. See
+// https://writeas.github.io/docs/#delete-a-post.
 func (c *Client) DeletePost(sp *PostParams) error {
 	env, err := c.delete(fmt.Sprintf("/posts/%s", sp.ID), map[string]string{
 		"token": sp.Token,
diff --git a/writeas.go b/writeas.go
index a5443f6..0d9c0f6 100644
--- a/writeas.go
+++ b/writeas.go
@@ -15,6 +15,8 @@ const (
 	apiURL = "https://write.as/api"
 )
 
+// Client is used to interact with the Write.as API. It can be used to make
+// authenticated or unauthenticated calls.
 type Client struct {
 	baseURL string
 
@@ -27,6 +29,11 @@ type Client struct {
 // defaultHTTPTimeout is the default http.Client timeout.
 const defaultHTTPTimeout = 10 * time.Second
 
+// NewClient creates a new API client. By default, all requests are made
+// unauthenticated. To optionally make authenticated requests, call `SetToken`.
+//
+//     c := writeas.NewClient()
+//     c.SetToken("00000000-0000-0000-0000-000000000000")
 func NewClient() *Client {
 	return &Client{
 		client:  &http.Client{Timeout: defaultHTTPTimeout},
@@ -34,6 +41,8 @@ func NewClient() *Client {
 	}
 }
 
+// SetToken sets the user token for all future Client requests. Setting this to
+// an empty string will change back to unauthenticated requests.
 func (c *Client) SetToken(token string) {
 	c.token = token
 }