From aee95468baff47ea29eb526fa995dbca3a8174d9 Mon Sep 17 00:00:00 2001
From: Brian Waldon <brian@waldon.cc>
Date: Tue, 27 Jan 2015 13:51:07 -0800
Subject: [PATCH] client: document MembersAPI/KeysAPI constructors

---
 client/keys.go    | 5 +++++
 client/members.go | 2 ++
 2 files changed, 7 insertions(+)

diff --git a/client/keys.go b/client/keys.go
index d6c931ce5..7dbe9877b 100644
--- a/client/keys.go
+++ b/client/keys.go
@@ -39,10 +39,15 @@ var (
 	defaultV2KeysPrefix = "/v2/keys"
 )
 
+// NewKeysAPI builds a KeysAPI that interacts with etcd's key-value
+// API over HTTP.
 func NewKeysAPI(c Client) KeysAPI {
 	return NewKeysAPIWithPrefix(c, defaultV2KeysPrefix)
 }
 
+// NewKeysAPIWithPrefix acts like NewKeysAPI, but allows the caller
+// to provide a custom base URL path. This should only be used in
+// very rare cases.
 func NewKeysAPIWithPrefix(c Client, p string) KeysAPI {
 	return &httpKeysAPI{
 		client: c,
diff --git a/client/members.go b/client/members.go
index c63ad97c0..69de9fa6c 100644
--- a/client/members.go
+++ b/client/members.go
@@ -31,6 +31,8 @@ var (
 	defaultV2MembersPrefix = "/v2/members"
 )
 
+// NewMembersAPI constructs a new MembersAPI that uses HTTP to
+// interact with etcd's membership API.
 func NewMembersAPI(c Client) MembersAPI {
 	return &httpMembersAPI{
 		client: c,