cli/command: ConfigureAuth: fix deprecation comment

thaJeztah · thaJeztah · commit 54e3685bcd0c · 2024-10-19T13:05:31.000+02:00
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 <github@gone.nl>
diff --git 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

Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,8 @@ func GetDefaultAuthConfig(cfg *configfile.ConfigFile, checkCredStore bool, serve`
`86`	`86`	`}`
`87`	`87`
`88`	`88`	`// ConfigureAuth handles prompting of user's username and password if needed.`
`89`		`-// Deprecated: use PromptUserForCredentials instead.`
	`89`	`+//`
	`90`	`+// Deprecated: use [PromptUserForCredentials] instead.`
`90`	`91`	`func ConfigureAuth(ctx context.Context, cli Cli, flUser, flPassword string, authConfig *registrytypes.AuthConfig, _ bool) error {`
`91`	`92`	`defaultUsername := authConfig.Username`
`92`	`93`	`serverAddress := authConfig.ServerAddress`