Adds comments

amir20 · Nov 30, 2018 · 27e8129 · 27e8129
1 parent 7d80137
commit 27e8129
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/docker/client.go b/docker/client.go
@@ -15,12 +15,14 @@ type dockerClient struct {
 	cli *client.Client
 }
 
+// Client is a proxy around the docker client
 type Client interface {
 	ListContainers() ([]Container, error)
 	ContainerLogs(ctx context.Context, id string) (io.ReadCloser, error)
 	Events(ctx context.Context) (<-chan events.Message, <-chan error)
 }
 
+// NewClient creates a new instance of Client
 func NewClient() Client {
 	cli, err := client.NewClientWithOpts(client.FromEnv)
 	if err != nil {

diff --git a/docker/types.go b/docker/types.go
@@ -1,5 +1,6 @@
 package docker
 
+// Container represents an internal representation of docker containers
 type Container struct {
 	ID      string   `json:"id"`
 	Names   []string `json:"names"`