Browse Source

client: document MembersAPI/KeysAPI constructors

Brian Waldon 11 years ago
parent
commit
aee95468ba
2 changed files with 7 additions and 0 deletions
  1. 5 0
      client/keys.go
  2. 2 0
      client/members.go

+ 5 - 0
client/keys.go

@@ -39,10 +39,15 @@ var (
 	defaultV2KeysPrefix = "/v2/keys"
 	defaultV2KeysPrefix = "/v2/keys"
 )
 )
 
 
+// NewKeysAPI builds a KeysAPI that interacts with etcd's key-value
+// API over HTTP.
 func NewKeysAPI(c Client) KeysAPI {
 func NewKeysAPI(c Client) KeysAPI {
 	return NewKeysAPIWithPrefix(c, defaultV2KeysPrefix)
 	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 {
 func NewKeysAPIWithPrefix(c Client, p string) KeysAPI {
 	return &httpKeysAPI{
 	return &httpKeysAPI{
 		client: c,
 		client: c,

+ 2 - 0
client/members.go

@@ -31,6 +31,8 @@ var (
 	defaultV2MembersPrefix = "/v2/members"
 	defaultV2MembersPrefix = "/v2/members"
 )
 )
 
 
+// NewMembersAPI constructs a new MembersAPI that uses HTTP to
+// interact with etcd's membership API.
 func NewMembersAPI(c Client) MembersAPI {
 func NewMembersAPI(c Client) MembersAPI {
 	return &httpMembersAPI{
 	return &httpMembersAPI{
 		client: c,
 		client: c,