Use consistent case for "Deprecated" comments (#2216)

* Use consistent case for "Deprecated" comments

Not the most important thing ever, but the canonical string to use for
Deprecated warnings is case sensitive, and also it's nice to be
consistent.

* Add nolint comment
This commit is contained in:
Julian Friedman 2021-08-17 17:15:16 +01:00 committed by GitHub
parent 35bcd16656
commit 50410e0b83
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 13 additions and 6 deletions

View File

@ -53,7 +53,8 @@ type Listable interface {
}
// Annotatable indicates that a particular type applies various annotations.
// DEPRECATED: Use WithUserInfo / GetUserInfo from within SetDefaults instead.
//
// Deprecated: Use WithUserInfo / GetUserInfo from within SetDefaults instead.
// The webhook functionality for this has been turned down, which is why this
// interface is empty.
type Annotatable interface{}

View File

@ -487,7 +487,8 @@ func (c *Impl) RunContext(ctx context.Context, threadiness int) error {
}
// Run runs the controller.
// DEPRECATED: Use RunContext instead.
//
// Deprecated: Use RunContext instead.
func (c *Impl) Run(threadiness int, stopCh <-chan struct{}) error {
// Create a context that is cancelled when the stopCh is called.
ctx, cancel := context.WithCancel(context.Background())

View File

@ -89,7 +89,8 @@ type ExporterOptions struct {
// UpdateExporterFromConfigMap returns a helper func that can be used to update the exporter
// when a config map is updated.
// DEPRECATED: Callers should migrate to ConfigMapWatcher.
//
// Deprecated: Callers should migrate to ConfigMapWatcher.
func UpdateExporterFromConfigMap(ctx context.Context, component string, logger *zap.SugaredLogger) func(configMap *corev1.ConfigMap) {
return ConfigMapWatcher(ctx, component, nil, logger)
}

View File

@ -99,7 +99,8 @@ func WaitForNewLeaders(ctx context.Context, t *testing.T, client kubernetes.Inte
}
// WaitForNewLeader waits until the holder of the given lease is different from the previousLeader.
// DEPRECATED: Use WaitForNewLeaders.
//
// Deprecated: Use WaitForNewLeaders.
func WaitForNewLeader(ctx context.Context, client kubernetes.Interface, lease, namespace, previousLeader string) (string, error) {
span := logging.GetEmitableSpan(ctx, "WaitForNewLeader/"+lease)
defer span.End()

View File

@ -38,6 +38,7 @@ func FakeZipkinExporter() (*recorder.ReporterRecorder, tracing.ConfigOption) {
// Create tracer with reporter recorder
reporter := recorder.NewReporter()
endpoint, _ := openzipkin.NewEndpoint("test", "localhost:1234")
//nolint:staticcheck // This is the new endpoint we're asking clients to use.
exp := tracing.WithZipkinExporter(func(cfg *config.Config) (zipkinreporter.Reporter, error) {
return reporter, nil
}, endpoint)

View File

@ -29,7 +29,8 @@ import (
type ZipkinReporterFactory func(*config.Config) (zipkinreporter.Reporter, error)
// WithZipkinExporter returns a config with zipkin enabled.
// DEPRECATED: This function is the legacy entrypoint and should be replaced with one of:
//
// Deprecated: This function is the legacy entrypoint and should be replaced with one of:
// - WithExporter() in production code
// - testing/FakeZipkinExporter() in test code.
func WithZipkinExporter(reporterFact ZipkinReporterFactory, endpoint *zipkinmodel.Endpoint) ConfigOption {

View File

@ -61,7 +61,8 @@ type Reference struct {
type Interface interface {
// Track tells us that "obj" is tracking changes to the
// referenced object.
// DEPRECATED: use TrackReference
//
// Deprecated: use TrackReference.
Track(ref corev1.ObjectReference, obj interface{}) error
// Track tells us that "obj" is tracking changes to the