From ac7d3d34541bbdc99c0c65cd07e48826fa2ea9bd Mon Sep 17 00:00:00 2001 From: Terin Stock Date: Thu, 7 Mar 2019 11:42:21 -0800 Subject: [PATCH] improve builder deprecation messages It's convention in the Go community that a function's deprecation notice is separated by a new paragraph from the function's documentation. Tools like staticcheck determine if a function has been deprecated by checking the beginning of new paragraphs. This changelist modifies the deprecation notices in the builder package to follow this convention, allowing linters like staticcheck, gometalinter, and golangci-lint to warn users of the package. --- pkg/builder/build.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/pkg/builder/build.go b/pkg/builder/build.go index 27bf56bf04..a884297a91 100644 --- a/pkg/builder/build.go +++ b/pkg/builder/build.go @@ -50,6 +50,7 @@ type Builder struct { } // SimpleController returns a new Builder. +// // Deprecated: Use ControllerManagedBy(Manager) instead. func SimpleController() *Builder { return &Builder{} @@ -64,6 +65,7 @@ func ControllerManagedBy(m manager.Manager) *Builder { // update events by *reconciling the object*. // This is the equivalent of calling // Watches(&source.Kind{Type: apiType}, &handler.EnqueueRequestForObject{}) +// // Deprecated: Use For func (blder *Builder) ForType(apiType runtime.Object) *Builder { return blder.For(apiType) @@ -99,6 +101,7 @@ func (blder *Builder) Watches(src source.Source, eventhandler handler.EventHandl } // WithConfig sets the Config to use for configuring clients. Defaults to the in-cluster config or to ~/.kube/config. +// // Deprecated: Use ControllerManagedBy(Manager) and this isn't needed. func (blder *Builder) WithConfig(config *rest.Config) *Builder { blder.config = config @@ -106,6 +109,7 @@ func (blder *Builder) WithConfig(config *rest.Config) *Builder { } // WithManager sets the Manager to use for registering the ControllerManagedBy. Defaults to a new manager.Manager. +// // Deprecated: Use ControllerManagedBy(Manager) and this isn't needed. func (blder *Builder) WithManager(m manager.Manager) *Builder { blder.mgr = m @@ -127,6 +131,7 @@ func (blder *Builder) Complete(r reconcile.Reconciler) error { } // Build builds the Application ControllerManagedBy and returns the Manager used to start it. +// // Deprecated: Use Complete func (blder *Builder) Build(r reconcile.Reconciler) (manager.Manager, error) { if r == nil {