Apply suggestions from code review

Co-authored-by: Wojtek Mach <wojtekmach@users.noreply.github.com>
peburrows · Feb 25, 2021 · 59ca258 · 59ca258
1 parent 6bd00e7
commit 59ca258
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -60,7 +60,7 @@ To query the metadata server for an access token, you must configure
 the following:
 
   * `url` must be set to the base url for the metadata server.
-  * `credentials` must be set to a tuple `{:instance, String.t()}`
+  * `credentials` must be set to a tuple `{:instance, account}`
     with the name of the service account to use.
 
 ```elixir

diff --git a/lib/goth.ex b/lib/goth.ex
@@ -32,7 +32,8 @@ defmodule Goth do
 
     * `:name` - the name to register the server under.
 
-    * `:credentials` - a map of credentials or a tuple `{:instance, String.t()}`.
+    * `:credentials` - a map of credentials or a tuple `{:instance, account}` (See
+      "Google Compute Metadata" section in the module documentation for more information.)
 
     * `:cooldown` - Time in milliseconds between retrying requests, defaults
       to `#{@cooldown}`.

diff --git a/lib/goth/token.ex b/lib/goth/token.ex
@@ -30,7 +30,8 @@ defmodule Goth.Token do
 
   Config may contain the following keys:
 
-    * `:credentials` - a map of credentials or a tuple `{:instance, String.t()}`.
+    * `:credentials` - a map of credentials or a tuple `{:instance, account}` (See
+      "Google Compute Metadata" section in the `Goth` module documentation for more information.)
 
     * `:scope` - Token scope, defaults to `#{inspect(@default_scope)}`.