Add godoc with note that setup codes cannot be used to decrypt

secrethub · Aug 14, 2020 · 88f5c0d · 88f5c0d
1 parent 7aac428
commit 88f5c0d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/pkg/secrethub/credentials/setup_code.go b/pkg/secrethub/credentials/setup_code.go
@@ -13,6 +13,8 @@ type SetupCode struct {
 	code string
 }
 
+// Provide implements the Provider interface for the setup code.
+// Note that no decrypter is ever returned as setup codes cannot be used to decrypt secrets.
 func (s *SetupCode) Provide(client *httpclient.Client) (auth.Authenticator, Decrypter, error) {
 	return s, nil, nil
 }