Permalink
Browse files

Clarify some more internal/deprecated docs.

  • Loading branch information...
1 parent 93fb5a3 commit 64ba49fa75a51a59b1ceb9d39d5360f02734f7ce @smashwilson smashwilson committed Oct 31, 2014
Showing with 14 additions and 7 deletions.
  1. +3 −3 auth_results.go
  2. +11 −4 results.go
View
@@ -2,9 +2,9 @@ package gophercloud
import "time"
-// AuthResults is a leftover type from the v0.x days. It was intended to
-// describe common functionality among identity service results, but is not
-// actually used anywhere.
+// AuthResults [deprecated] is a leftover type from the v0.x days. It was
+// intended to describe common functionality among identity service results, but
+// is not actually used anywhere.
type AuthResults interface {
// TokenID returns the token's ID value from the authentication response.
TokenID() (string, error)
View
@@ -6,7 +6,8 @@ import (
)
/*
-Result is an internal type to be used by individual resource packages.
+Result is an internal type to be used by individual resource packages, but its
+methods will be available on a wide variety of user-facing embedding types.
It acts as a base struct that other Result types, returned from request
functions, can embed for convenience. All Results capture basic information
@@ -42,10 +43,15 @@ func (r Result) PrettyPrintJSON() string {
return string(pretty)
}
-// ErrResult represents results that only contain a potential error and
+// ErrResult is an internal type to be used by individual resource packages, but
+// its methods will be available on a wide variety of user-facing embedding
+// types.
+//
+// It represents results that only contain a potential error and
// nothing else. Usually, if the operation executed successfully, the Err field
// will be nil; otherwise it will be stocked with a relevant error. Use the
-// ExtractErr method to cleanly pull it out.
+// ExtractErr method
+// to cleanly pull it out.
type ErrResult struct {
Result
}
@@ -56,7 +62,8 @@ func (r ErrResult) ExtractErr() error {
}
/*
-HeaderResult is an internal type to be used by individual resource packages.
+HeaderResult is an internal type to be used by individual resource packages, but
+its methods will be available on a wide variety of user-facing embedding types.
It represents a result that only contains an error (possibly nil) and an
http.Header. This is used, for example, by the objectstorage packages in

0 comments on commit 64ba49f

Please sign in to comment.