Godoc fixes (#898)

Add some godoc comments for the api/agent package and some of its
subpackages.
This commit is contained in:
Justin Ko
2018-03-28 10:16:41 -07:00
committed by Reed Allman
parent 14af8805de
commit 9cb883ca68
7 changed files with 68 additions and 8 deletions

14
api/agent/drivers/doc.go Normal file
View File

@@ -0,0 +1,14 @@
// Package drivers is intended as a general purpose container abstraction
// library. It abstracts across the differences between different container
// runtimes (e.g. Docker, Rkt, etc.) and provides utlities and data types that
// are common across all runtimes.
//
// Docker Driver
//
// The docker driver runs functions as Docker containers.
//
// Mock Driver
//
// The mock driver pretends to run functions but doesn't actually run them. This
// is for testing only.
package drivers

View File

@@ -0,0 +1,5 @@
// Package docker provides a Docker driver for Fn. Provides an implementation
// of
// github.com/fnproject/fn/api/agent/drivers.Driver
// that knows how to run Docker images.
package docker

View File

@@ -1,3 +1,4 @@
// Package mock provides a fake Driver implementation that is only used for testing.
package mock
import (