cli/command: ConfigureAuth: fix deprecation comment

Deprecation comments must have an empty line before them, otherwise tools and linters may not recognise them. While fixing this, also updated the reference to PromptUserForCredentials to be a docs-link to make it clickable. Updates 6e4818e. Signed-off-by: Sebastiaan van Stijn <[email protected]> (cherry picked from commit 54e3685) Signed-off-by: Sebastiaan van Stijn <[email protected]>
docker · Oct 19, 2024 · a8a8f68 · a8a8f68
1 parent 0008d79
commit a8a8f68
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/cli/command/registry.go b/cli/command/registry.go
@@ -87,7 +87,8 @@ func GetDefaultAuthConfig(cfg *configfile.ConfigFile, checkCredStore bool, serve
 }
 
 // ConfigureAuth handles prompting of user's username and password if needed.
-// Deprecated: use PromptUserForCredentials instead.
+//
+// Deprecated: use [PromptUserForCredentials] instead.
 func ConfigureAuth(ctx context.Context, cli Cli, flUser, flPassword string, authConfig *registrytypes.AuthConfig, _ bool) error {
 	defaultUsername := authConfig.Username
 	serverAddress := authConfig.ServerAddress