waitfor comment

types/types.go

@@ -390,6 +390,7 @@ func ParsePullPolicyValue(s string) PullPolicyValue {
 	return PullPolicyIfNotPresent
 }
 
+// WaitFor represents the wait-for configuration for a node deployment stage.
 type WaitFor struct {
 	Node  string       `json:"node"`            // the node that is to be waited for
 	State WaitForPhase `json:"state,omitempty"` // the state that the node must have completed
@@ -400,9 +401,9 @@ func (w *WaitFor) IsValid() error {
 	return err
 }
 
-// WaitForPhase defines the phases that nodes pass
-// on deployment. They are used to define and enforce
-// dependencies between nodes
+// WaitForPhase defines the phases that nodes go through
+// during the deployment process. They are used to define and enforce
+// dependencies between nodes.
 type WaitForPhase string
 
 const (