clarify the comments

This commit is contained in:
Donny Xia
2020-11-03 13:09:12 -08:00
parent be327e7443
commit 3fed68b694
2 changed files with 12 additions and 5 deletions

View File

@@ -41,8 +41,14 @@ func (a ElementAppender) Filter(rn *RNode) (*RNode, error) {
return nil, nil
}
// ElementSetter sets the value for an Element in an associative list. ElementSetter
// ElementSetter sets the value for an Element in an associative list. ElementSetter
// will remove any elements which are empty.
// ElementSetter will append, replace or delete an element in an associative list.
// To append, user a key-value pair that doesn't exist in the sequence. Note: this
// behavior is intended to handle the case that not matching element found. It's
// not designed for this purpose. To append an element, please use ElementAppender.
// To replace, set the key-value pair and a non-nil Element.
// To delete, set the key-value pair and leave the Element as nil.
type ElementSetter struct {
Kind string `yaml:"kind,omitempty"`