Making root docs more consistent
diff --git a/provider_client.go b/provider_client.go
index 2be665e..7754c20 100644
--- a/provider_client.go
+++ b/provider_client.go
@@ -1,29 +1,33 @@
package gophercloud
-// ProviderClient stores details that are required to interact with any services within a specific provider's API.
+// ProviderClient stores details that are required to interact with any
+// services within a specific provider's API.
//
-// Generally, you acquire a ProviderClient by calling the `NewClient()` method in the appropriate provider's child package,
-// providing whatever authentication credentials are required.
+// Generally, you acquire a ProviderClient by calling the NewClient method in
+// the appropriate provider's child package, providing whatever authentication
+// credentials are required.
type ProviderClient struct {
-
- // IdentityBase is the front door to an openstack provider.
- // Generally this will be populated when you authenticate.
- // It should be the *root* resource of the identity service, not of a specific identity version.
+ // IdentityBase is the base URL used for a particular provider's identity
+ // service - it will be used when issuing authenticatation requests. It
+ // should point to the root resource of the identity service, not a specific
+ // identity version.
IdentityBase string
- // IdentityEndpoint is the originally requested identity endpoint.
- // This may be a specific version of the identity service, in which case that endpoint is used rather than querying the
- // version-negotiation endpoint.
+ // IdentityEndpoint is the identity endpoint. This may be a specific version
+ // of the identity service. If this is the case, this endpoint is used rather
+ // than querying versions first.
IdentityEndpoint string
- // TokenID is the most recently valid token issued.
+ // TokenID is the ID of the most recently issued valid token.
TokenID string
- // EndpointLocator describes how this provider discovers the endpoints for its constituent services.
+ // EndpointLocator describes how this provider discovers the endpoints for
+ // its constituent services.
EndpointLocator EndpointLocator
}
-// AuthenticatedHeaders returns a map of HTTP headers that are common for all authenticated service requests.
+// AuthenticatedHeaders returns a map of HTTP headers that are common for all
+// authenticated service requests.
func (client *ProviderClient) AuthenticatedHeaders() map[string]string {
return map[string]string{"X-Auth-Token": client.TokenID}
}