Merge pull request #4105 from thaJeztah/fix_comments

thaJeztah · web-flow · commit bfe87fd39b6b · 2023-03-21T17:52:26.000+01:00
cli/command: ElectAuthServer: fix deprecation comment
diff --git a/cli/command/registry.go b/cli/command/registry.go
@@ -21,8 +21,9 @@ import (
 	"github.com/pkg/errors"
 )
 
-// ElectAuthServer returns the default registry to use
-// Deprecated: use registry.IndexServer instead
+// ElectAuthServer returns the default registry to use.
+//
+// Deprecated: use [registry.IndexServer] instead.
 func ElectAuthServer(_ context.Context, _ Cli) string {
 	return registry.IndexServer
 }
diff --git a/cli/command/registry_test.go b/cli/command/registry_test.go
@@ -6,16 +6,13 @@ import (
 	"fmt"
 	"testing"
 
-	"gotest.tools/v3/assert"
-	is "gotest.tools/v3/assert/cmp"
-
-	// Prevents a circular import with "github.com/docker/cli/internal/test"
-
-	. "github.com/docker/cli/cli/command"
+	. "github.com/docker/cli/cli/command" // Prevents a circular import with "github.com/docker/cli/internal/test"
 	configtypes "github.com/docker/cli/cli/config/types"
 	"github.com/docker/cli/internal/test"
 	"github.com/docker/docker/api/types"
 	"github.com/docker/docker/client"
+	"gotest.tools/v3/assert"
+	is "gotest.tools/v3/assert/cmp"
 )
 
 type fakeClient struct {

Original file line number	Diff line number	Diff line change
`@@ -21,8 +21,9 @@ import (`
`21`	`21`	`"github.com/pkg/errors"`
`22`	`22`	`)`
`23`	`23`
`24`		`-// ElectAuthServer returns the default registry to use`
`25`		`-// Deprecated: use registry.IndexServer instead`
	`24`	`+// ElectAuthServer returns the default registry to use.`
	`25`	`+//`
	`26`	`+// Deprecated: use [registry.IndexServer] instead.`
`26`	`27`	`func ElectAuthServer(_ context.Context, _ Cli) string {`
`27`	`28`	`return registry.IndexServer`
`28`	`29`	`}`