Update docstrings

Co-Authored-By: isaachawley <isaachawley@gmail.com>

Author: 2 people

client/nginx.go

@@ -791,12 +791,12 @@ type KeyValPairs map[string]string
 // KeyValPairsByZone are the KeyValPairs for all zones, by zone name.
 type KeyValPairsByZone map[string]KeyValPairs
 
-// GetKeyValPairs fetches key/value pairs for a given zone.
+// GetKeyValPairs fetches key/value pairs for a given HTTP zone.
 func (client *NginxClient) GetKeyValPairs(zone string) (KeyValPairs, error) {
 	return client.getKeyValPairs(zone, HTTP)
 }
 
-// GetStreamKeyValPairs fetches key/value pairs for a given zone.
+// GetStreamKeyValPairs fetches key/value pairs for a given Stream zone.
 func (client *NginxClient) GetStreamKeyValPairs(zone string) (KeyValPairs, error) {
 	return client.getKeyValPairs(zone, Stream)
 }
@@ -817,12 +817,12 @@ func (client *NginxClient) getKeyValPairs(zone string, stream bool) (KeyValPairs
 	return keyvals, nil
 }
 
-// GetAllKeyValPairs fetches all key/value pairs for all zones.
+// GetAllKeyValPairs fetches all key/value pairs for all HTTP zones.
 func (client *NginxClient) GetAllKeyValPairs() (KeyValPairsByZone, error) {
 	return client.getAllKeyValPairs(HTTP)
 }
 
-// GetStreamAllKeyValPairs fetches all key/value pairs for all zones.
+// GetStreamAllKeyValPairs fetches all key/value pairs for all Stream zones.
 func (client *NginxClient) GetStreamAllKeyValPairs() (KeyValPairsByZone, error) {
 	return client.getAllKeyValPairs(Stream)
 }
@@ -841,12 +841,12 @@ func (client *NginxClient) getAllKeyValPairs(stream bool) (KeyValPairsByZone, er
 	return keyvals, nil
 }
 
-// AddKeyValPair adds a new key/value pair.
+// AddKeyValPair adds a new key/value pair to a given HTTP zone.
 func (client *NginxClient) AddKeyValPair(zone string, keyval KeyValPairs) error {
 	return client.addKeyValPair(zone, keyval, HTTP)
 }
 
-// AddStreamKeyValPair adds a new key/value pair.
+// AddStreamKeyValPair adds a new key/value pair to a given Stream zone.
 func (client *NginxClient) AddStreamKeyValPair(zone string, keyval KeyValPairs) error {
 	return client.addKeyValPair(zone, keyval, Stream)
 }
@@ -883,7 +883,7 @@ func (client *NginxClient) addKeyValPair(zone string, keyval KeyValPairs, stream
 	return nil
 }
 
-// ModifyKeyValPair modifies the value of an existing key.
+// ModifyKeyValPair modifies the value of an existing key in a given HTTP zone.
 func (client *NginxClient) ModifyKeyValPair(zone string, keyval KeyValPairs) error {
 	return client.modifyKeyValPair(zone, keyval, HTTP)
 }
@@ -985,12 +985,12 @@ func (client *NginxClient) deleteKeyValuePair(zone string, key string, stream bo
 	return nil
 }
 
-// DeleteKeyValuePairs deletes all the key-value pairs in a given zone.
+// DeleteKeyValuePairs deletes all the key-value pairs in a given HTTP zone.
 func (client *NginxClient) DeleteKeyValuePairs(zone string) error {
 	return client.deleteKeyValPairs(zone, HTTP)
 }
 
-// DeleteStreamKeyValuePairs deletes all the key-value pairs in a given zone.
+// DeleteStreamKeyValuePairs deletes all the key-value pairs in a given Stream zone.
 func (client *NginxClient) DeleteStreamKeyValuePairs(zone string) error {
 	return client.deleteKeyValPairs(zone, Stream)
 }