proof-read documentation

1 files changed, 5 insertions, 3 deletions

diff --git a/backend.go b/backend.go
index 50d8e4c..de07015 100644
--- a/backend.go
+++ b/backend.go
@@ -23,14 +23,15 @@ import (
 )
 
 //Backend is the interface between Schwift and the libraries providing
-//authentication for it.
+//authentication for it. Each instance of Backend represents a particular Swift
+//account.
 type Backend interface {
 	//EndpointURL returns the endpoint URL from the Keystone catalog for the
 	//Swift account that this backend operates on. It should look like
-	//`http://domain.tld/v1/AUTH_projectid/`.
+	//`http://domain.tld/v1/AUTH_projectid/`. The trailing slash is required.
 	EndpointURL() string
 	//Clone returns a deep clone of this backend with the endpoint URL changed to
-	//the given URL.
+	//the given URL. This is used by Account.SwitchAccount().
 	Clone(newEndpointURL string) Backend
 	//Do executes the given HTTP request after adding to it the X-Auth-Token
 	//header containing the backend's current Keystone (or Swift auth) token. It
@@ -38,4 +39,5 @@ type Backend interface {
 	//is 401, it shall attempt to acquire a new auth token and restart the
 	//request with the new token.
 	Do(req *http.Request) (*http.Response, error)
+	//TODO add UserAgent argument to Do()
 }