From 54e3685bcd0c16e88eb03a5ded4cd425e3aef056 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Sat, 19 Oct 2024 13:05:31 +0200 Subject: [PATCH] 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 6e4818e7d6d006f14ebac4c06fbe6ed958237408. Signed-off-by: Sebastiaan van Stijn --- cli/command/registry.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/cli/command/registry.go b/cli/command/registry.go index 7be5f5a2903d..efdd21b8d505 100644 --- a/cli/command/registry.go +++ b/cli/command/registry.go @@ -86,7 +86,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