Merge pull request #2382 from zaunerc/master

Add info about return values for function Get().
This commit is contained in:
James Phillips 2016-10-20 09:40:58 -07:00 committed by GitHub
commit 554c898338
1 changed files with 2 additions and 1 deletions

View File

@ -92,7 +92,8 @@ func (c *Client) KV() *KV {
return &KV{c} return &KV{c}
} }
// Get is used to lookup a single key // Get is used to lookup a single key. The returned pointer
// to the KVPair will be nil if the key does not exist.
func (k *KV) Get(key string, q *QueryOptions) (*KVPair, *QueryMeta, error) { func (k *KV) Get(key string, q *QueryOptions) (*KVPair, *QueryMeta, error) {
resp, qm, err := k.getInternal(key, nil, q) resp, qm, err := k.getInternal(key, nil, q)
if err != nil { if err != nil {