From 08ad5b83fae708891db89a2709b269129a2113a2 Mon Sep 17 00:00:00 2001 From: Jonathan Amsterdam Date: Thu, 12 Apr 2018 06:23:22 -0400 Subject: [PATCH] cloud: improve package doc Responses to Ahmet's comments on the already submitted https://code-review.googlesource.com/c/gocloud/+/26310. Change-Id: I2cca196f0ca04ad5b1b3e349bd168f3af44c266a Reviewed-on: https://code-review.googlesource.com/26350 Reviewed-by: kokoro Reviewed-by: Ahmet Alp Balkan Reviewed-by: Jonathan Amsterdam --- cloud.go | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/cloud.go b/cloud.go index 537184e899e0..3bd06a52a8ab 100644 --- a/cloud.go +++ b/cloud.go @@ -20,15 +20,17 @@ of sub-packages. Authentication and Authorization -All the clients in sub-packages support authentication via Google Application Default Credentials, -or by providing credentials in JSON form. See the authentication examples in this package for details. +All the clients in sub-packages support authentication via Google Application Default +Credentials (see https://cloud.google.com/docs/authentication/production), or +by providing a JSON key file for a Service Account. See the authentication examples +in this package for details. Timeouts and Cancellation -By default, all RPCs made by the clients in sub-packages will run indefinitely, retrying on -temporary errors when correctness allows. To set timeouts or arrange for cancellation, use contexts. -See the examples for details. +By default, all requests in sub-packages will run indefinitely, retrying on transient +errors when correctness allows. To set timeouts or arrange for cancellation, use +contexts. See the examples for details. Do not attempt to control the initial connection (dialing) of a service by setting a timeout on the context passed to NewClient. Dialing is non-blocking, so timeouts