Skip to content

Commit ddea395

Browse files
author
Samuel Ortiz
committed
plugin: Fix runtime interface documentation
Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>
1 parent 7e3b7de commit ddea395

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

plugin/runtime.go

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,15 @@ type Exit struct {
3434
type Runtime interface {
3535
// ID of the runtime
3636
ID() string
37-
// Create creates a container with the provided id and options
37+
// Create creates a task with the provided id and options.
3838
Create(ctx context.Context, id string, opts CreateOpts) (Task, error)
39-
// Get returns a container
39+
// Get returns a task.
4040
Get(context.Context, string) (Task, error)
41-
// Containers returns all the current containers for the runtime
41+
// Tasks returns all the current tasks for the runtime.
42+
// Any container runs at most one task at a time.
4243
Tasks(context.Context) ([]Task, error)
43-
// Delete removes the container in the runtime
44+
// Delete removes the task in the runtime.
4445
Delete(context.Context, Task) (*Exit, error)
45-
// Events returns events for the runtime and all containers created by the runtime
46+
// Events returns events for the runtime and all tasks created by the runtime
4647
Events(context.Context) <-chan *Event
4748
}

0 commit comments

Comments
 (0)