mirror of https://github.com/knative/pkg.git
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:
parent
35bcd16656
commit
50410e0b83
|
@ -53,7 +53,8 @@ type Listable interface {
|
||||||
}
|
}
|
||||||
|
|
||||||
// Annotatable indicates that a particular type applies various annotations.
|
// 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
|
// The webhook functionality for this has been turned down, which is why this
|
||||||
// interface is empty.
|
// interface is empty.
|
||||||
type Annotatable interface{}
|
type Annotatable interface{}
|
||||||
|
|
|
@ -487,7 +487,8 @@ func (c *Impl) RunContext(ctx context.Context, threadiness int) error {
|
||||||
}
|
}
|
||||||
|
|
||||||
// Run runs the controller.
|
// Run runs the controller.
|
||||||
// DEPRECATED: Use RunContext instead.
|
//
|
||||||
|
// Deprecated: Use RunContext instead.
|
||||||
func (c *Impl) Run(threadiness int, stopCh <-chan struct{}) error {
|
func (c *Impl) Run(threadiness int, stopCh <-chan struct{}) error {
|
||||||
// Create a context that is cancelled when the stopCh is called.
|
// Create a context that is cancelled when the stopCh is called.
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
|
|
@ -89,7 +89,8 @@ type ExporterOptions struct {
|
||||||
|
|
||||||
// UpdateExporterFromConfigMap returns a helper func that can be used to update the exporter
|
// UpdateExporterFromConfigMap returns a helper func that can be used to update the exporter
|
||||||
// when a config map is updated.
|
// 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) {
|
func UpdateExporterFromConfigMap(ctx context.Context, component string, logger *zap.SugaredLogger) func(configMap *corev1.ConfigMap) {
|
||||||
return ConfigMapWatcher(ctx, component, nil, logger)
|
return ConfigMapWatcher(ctx, component, nil, logger)
|
||||||
}
|
}
|
||||||
|
|
|
@ -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.
|
// 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) {
|
func WaitForNewLeader(ctx context.Context, client kubernetes.Interface, lease, namespace, previousLeader string) (string, error) {
|
||||||
span := logging.GetEmitableSpan(ctx, "WaitForNewLeader/"+lease)
|
span := logging.GetEmitableSpan(ctx, "WaitForNewLeader/"+lease)
|
||||||
defer span.End()
|
defer span.End()
|
||||||
|
|
|
@ -38,6 +38,7 @@ func FakeZipkinExporter() (*recorder.ReporterRecorder, tracing.ConfigOption) {
|
||||||
// Create tracer with reporter recorder
|
// Create tracer with reporter recorder
|
||||||
reporter := recorder.NewReporter()
|
reporter := recorder.NewReporter()
|
||||||
endpoint, _ := openzipkin.NewEndpoint("test", "localhost:1234")
|
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) {
|
exp := tracing.WithZipkinExporter(func(cfg *config.Config) (zipkinreporter.Reporter, error) {
|
||||||
return reporter, nil
|
return reporter, nil
|
||||||
}, endpoint)
|
}, endpoint)
|
||||||
|
|
|
@ -29,7 +29,8 @@ import (
|
||||||
type ZipkinReporterFactory func(*config.Config) (zipkinreporter.Reporter, error)
|
type ZipkinReporterFactory func(*config.Config) (zipkinreporter.Reporter, error)
|
||||||
|
|
||||||
// WithZipkinExporter returns a config with zipkin enabled.
|
// 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
|
// - WithExporter() in production code
|
||||||
// - testing/FakeZipkinExporter() in test code.
|
// - testing/FakeZipkinExporter() in test code.
|
||||||
func WithZipkinExporter(reporterFact ZipkinReporterFactory, endpoint *zipkinmodel.Endpoint) ConfigOption {
|
func WithZipkinExporter(reporterFact ZipkinReporterFactory, endpoint *zipkinmodel.Endpoint) ConfigOption {
|
||||||
|
|
|
@ -61,7 +61,8 @@ type Reference struct {
|
||||||
type Interface interface {
|
type Interface interface {
|
||||||
// Track tells us that "obj" is tracking changes to the
|
// Track tells us that "obj" is tracking changes to the
|
||||||
// referenced object.
|
// referenced object.
|
||||||
// DEPRECATED: use TrackReference
|
//
|
||||||
|
// Deprecated: use TrackReference.
|
||||||
Track(ref corev1.ObjectReference, obj interface{}) error
|
Track(ref corev1.ObjectReference, obj interface{}) error
|
||||||
|
|
||||||
// Track tells us that "obj" is tracking changes to the
|
// Track tells us that "obj" is tracking changes to the
|
||||||
|
|
Loading…
Reference in New Issue