chore: Update BaseClient documentation comment

googleapis · Oct 28, 2022 · a89e880 · a89e880
1 parent ce07c11
commit a89e880
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/lib/googleauth/base_client.rb b/lib/googleauth/base_client.rb
@@ -20,7 +20,9 @@ module Google
   module Auth
     # BaseClient is a class used to contain common methods that are required by any
     # Credentials Client, including AwsCredentials, ServiceAccountCredentials,
-    # and UserRefreshCredentials.
+    # and UserRefreshCredentials. This is a superclass of Signet::OAuth2::Client
+    # and has been created to create a generic interface for all credentials clients
+    # to use, including ones which do not inherit from Signet::OAuth2::Client.
     module BaseClient
       AUTH_METADATA_KEY = :authorization