beenull/moby
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

client: deprecate NewClient properly

Browse source 
The 'Deprecated:' line in NewClient's doc comment was not in a new
paragraph, so GoDoc, linters, and IDEs were unaware that it was
deprecated. The package documentation also continued to reference
NewClient. Update the doc comments to finish documenting that NewClient
is deprecated.

Signed-off-by: Cory Snider <csnider@mirantis.com>
This commit is contained in:
Cory Snider 2023-03-31 16:15:01 -04:00
parent d94d51d00b
commit 6b9968e8b1
2 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
client/client.go
View file

@ -6,9 +6,10 @@ https://docs.docker.com/engine/api/
# Usage # Usage
You use the library by creating a client object and calling methods on it. The You use the library by constructing a client object using [NewClientWithOpts]
client can be created either from environment variables with NewClientWithOpts(client.FromEnv), and calling methods on it. The client can be configured from environment
or configured manually with NewClient(). variables by passing the [FromEnv] option, or configured manually by passing any
of the other available [Opts].
For example, to list running containers (the equivalent of "docker ps"): For example, to list running containers (the equivalent of "docker ps"):

8
client/client_deprecated.go
View file

@ -9,7 +9,11 @@ import "net/http"
// It won't send any version information if the version number is empty. It is // It won't send any version information if the version number is empty. It is
// highly recommended that you set a version or your client may break if the // highly recommended that you set a version or your client may break if the
// server is upgraded. // server is upgraded.
// Deprecated: use NewClientWithOpts //
// Deprecated: use [NewClientWithOpts] passing the [WithHost], [WithVersion],
// [WithHTTPClient] and [WithHTTPHeaders] options. We recommend enabling API
// version negotiation by passing the [WithAPIVersionNegotiation] option instead
// of WithVersion.
func NewClient(host string, version string, client *http.Client, httpHeaders map[string]string) (*Client, error) { func NewClient(host string, version string, client *http.Client, httpHeaders map[string]string) (*Client, error) {
return NewClientWithOpts(WithHost(host), WithVersion(version), WithHTTPClient(client), WithHTTPHeaders(httpHeaders)) return NewClientWithOpts(WithHost(host), WithVersion(version), WithHTTPClient(client), WithHTTPHeaders(httpHeaders))
} }
@ -17,7 +21,7 @@ func NewClient(host string, version string, client *http.Client, httpHeaders map
// NewEnvClient initializes a new API client based on environment variables. // NewEnvClient initializes a new API client based on environment variables.
// See FromEnv for a list of support environment variables. // See FromEnv for a list of support environment variables.
// //
// Deprecated: use NewClientWithOpts(FromEnv) // Deprecated: use [NewClientWithOpts] passing the [FromEnv] option.
func NewEnvClient() (*Client, error) { func NewEnvClient() (*Client, error) {
return NewClientWithOpts(FromEnv) return NewClientWithOpts(FromEnv)
} }