Improve package doc.

This commit is contained in:
Jeffrey Regan
2018-06-06 11:00:57 -07:00
parent ba2866645e
commit 2e0e43cd76
17 changed files with 52 additions and 8 deletions

View File

@@ -14,12 +14,13 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
// Package transformers has implementations of resmap.ResMap transformers.
package transformers
import "github.com/kubernetes-sigs/kustomize/pkg/resmap"
// Transformer can transform objects.
// A Transformer modifies an instance of resmap.ResMap.
type Transformer interface {
// Transform modifies objects in a map, e.g. add prefixes or additional labels.
// Transform modifies data in the argument, e.g. adding labels to resources that can be labelled.
Transform(m resmap.ResMap) error
}