diff options
| author | Sebastiaan van Stijn <github@gone.nl> | 2022-07-08 18:27:07 +0200 |
|---|---|---|
| committer | Sebastiaan van Stijn <github@gone.nl> | 2022-07-13 22:42:29 +0200 |
| commit | cdbca4061ba2e45924e0ce93c8c3afb5c8de4a9f (patch) | |
| tree | 66367a46e2bca5db1467bf5b80eb8d82ec260cd8 /client | |
| parent | c52e221207a42a2ed9e5d4f9f1112cb8ca227a2b (diff) | |
| download | docker-cdbca4061ba2e45924e0ce93c8c3afb5c8de4a9f.tar.gz | |
gofmt GoDoc comments with go1.19
Older versions of Go don't format comments, so committing this as
a separate commit, so that we can already make these changes before
we upgrade to Go 1.19.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 52c1a2fae8ffe3efc8b24ef53a702582131ebc57)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Diffstat (limited to 'client')
| -rw-r--r-- | client/client.go | 5 | ||||
| -rw-r--r-- | client/container_attach.go | 2 | ||||
| -rw-r--r-- | client/container_logs.go | 2 |
3 files changed, 3 insertions, 6 deletions
diff --git a/client/client.go b/client/client.go index 1412377eab..26a0fa2756 100644 --- a/client/client.go +++ b/client/client.go @@ -4,7 +4,7 @@ Package client is a Go client for the Docker Engine API. For more information about the Engine API, see the documentation: https://docs.docker.com/engine/api/ -Usage +# Usage You use the library by creating a client object and calling methods on it. The client can be created either from environment variables with NewClientWithOpts(client.FromEnv), @@ -37,7 +37,6 @@ For example, to list running containers (the equivalent of "docker ps"): fmt.Printf("%s %s\n", container.ID[:10], container.Image) } } - */ package client // import "github.com/docker/docker/client" @@ -121,12 +120,10 @@ func CheckRedirect(req *http.Request, via []*http.Request) error { // itself with values from environment variables (client.FromEnv), and has // automatic API version negotiation enabled (client.WithAPIVersionNegotiation()). // -// // cli, err := client.NewClientWithOpts( // client.FromEnv, // client.WithAPIVersionNegotiation(), // ) -// func NewClientWithOpts(ops ...Opt) (*Client, error) { client, err := defaultHTTPClient(DefaultDockerHost) if err != nil { diff --git a/client/container_attach.go b/client/container_attach.go index 404d2a0dc5..ba92117d3e 100644 --- a/client/container_attach.go +++ b/client/container_attach.go @@ -22,7 +22,7 @@ import ( // multiplexed. // The format of the multiplexed stream is as follows: // -// [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}[]byte{OUTPUT} +// [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}[]byte{OUTPUT} // // STREAM_TYPE can be 1 for stdout and 2 for stderr // diff --git a/client/container_logs.go b/client/container_logs.go index e9ae2f680f..9bdf2b0fa6 100644 --- a/client/container_logs.go +++ b/client/container_logs.go @@ -24,7 +24,7 @@ import ( // multiplexed. // The format of the multiplexed stream is as follows: // -// [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}[]byte{OUTPUT} +// [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}[]byte{OUTPUT} // // STREAM_TYPE can be 1 for stdout and 2 for stderr // |