engine: Fix typos
This commit is contained in:
@@ -125,7 +125,7 @@ func (obj *Engine) Validate() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Apply a function to the pending graph. You must pass in a function which will
|
// Apply a function to the pending graph. You must pass in a function which will
|
||||||
// receive this graph as input, and return an error if it something does not
|
// receive this graph as input, and return an error if something does not
|
||||||
// succeed.
|
// succeed.
|
||||||
func (obj *Engine) Apply(fn func(*pgraph.Graph) error) error {
|
func (obj *Engine) Apply(fn func(*pgraph.Graph) error) error {
|
||||||
return fn(obj.nextGraph)
|
return fn(obj.nextGraph)
|
||||||
|
|||||||
@@ -192,12 +192,12 @@ type Res interface {
|
|||||||
// in response.
|
// in response.
|
||||||
Watch() error
|
Watch() error
|
||||||
|
|
||||||
// CheckApply determines if the state of the resource is connect and if
|
// CheckApply determines if the state of the resource is correct and if
|
||||||
// asked to with the `apply` variable, applies the requested state.
|
// asked to with the `apply` variable, applies the requested state.
|
||||||
CheckApply(apply bool) (checkOK bool, err error)
|
CheckApply(apply bool) (checkOK bool, err error)
|
||||||
|
|
||||||
// Cmp compares itself to another resource and returns an error if they
|
// Cmp compares itself to another resource and returns an error if they
|
||||||
// are not equivalent. This is more strict than the Equiv method of the
|
// are not equivalent. This is more strict than the Adapts method of the
|
||||||
// CompatibleRes interface which allows for equivalent differences if
|
// CompatibleRes interface which allows for equivalent differences if
|
||||||
// the have a compatible result in CheckApply.
|
// the have a compatible result in CheckApply.
|
||||||
Cmp(Res) error
|
Cmp(Res) error
|
||||||
@@ -248,11 +248,11 @@ type InterruptableRes interface {
|
|||||||
// is designed to unblock any long running operation that is occurring
|
// is designed to unblock any long running operation that is occurring
|
||||||
// in the CheckApply portion of the life cycle. If the resource has
|
// in the CheckApply portion of the life cycle. If the resource has
|
||||||
// already exited, running this method should not block. (That is to say
|
// already exited, running this method should not block. (That is to say
|
||||||
// that you should not expect CheckApply or Watch to be able to alive
|
// that you should not expect CheckApply or Watch to be alive and be
|
||||||
// and able to read from a channel to satisfy your request.) It is best
|
// able to read from a channel to satisfy your request.) It is best to
|
||||||
// to probably have this close a channel to multicast that signal around
|
// probably have this close a channel to multicast that signal around to
|
||||||
// to anyone who can detect it in a select. If you are in a situation
|
// anyone who can detect it in a select. If you are in a situation which
|
||||||
// which cannot interrupt, then you can return an error.
|
// cannot interrupt, then you can return an error.
|
||||||
// FIXME: implement, and check the above description is what we expect!
|
// FIXME: implement, and check the above description is what we expect!
|
||||||
Interrupt() error
|
Interrupt() error
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user