Skip to content

Commit

Permalink
Fixup: indents in-comment code blocks and wordings
Browse files Browse the repository at this point in the history
Signed-off-by: Hidde Beydals <[email protected]>
  • Loading branch information
hiddeco committed Jul 6, 2021
1 parent 18c56eb commit 9301197
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion runtime/client/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ const (
//
// // Get a runtime Kubernetes client configuration with the options set
// restConfig := client.GetConfigOrDie(clientOptions)
// }
// }
type Options struct {
// QPS indicates the maximum queries-per-second of requests sent to to the Kubernetes API, defaults to 20.
QPS float32
Expand Down
2 changes: 1 addition & 1 deletion runtime/controller/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ type Metrics struct {
// MustMakeMetrics creates a new Metrics with a new metrics.Recorder, and the Metrics.Scheme set to that of the given
// mgr.
// It attempts to register the metrics collectors in the controller-runtime metrics registry, which panics upon the
// first registration that causes an error. Which usually happens if you try to initialize a Metrics value twice for
// first registration that causes an error. Which usually happens if you try to initialise a Metrics value twice for
// your controller.
func MustMakeMetrics(mgr ctrl.Manager) Metrics {
metricsRecorder := metrics.NewRecorder()
Expand Down
2 changes: 1 addition & 1 deletion runtime/leaderelection/leaderelection.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ const (
// RenewDeadline: &leaderElectionOptions.RenewDeadline,
// RetryPeriod: &leaderElectionOptions.RetryPeriod,
// })
// }
// }
type Options struct {
// Enable determines whether or not to use leader election when starting the manager.
Enable bool
Expand Down
2 changes: 1 addition & 1 deletion runtime/logger/logger.go
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ var stackLevelStrings = map[string]zapcore.Level{
//
// // Use the values during the initialisation of the logger
// ctrl.SetLogger(logger.NewLogger(logOptions))
// }
// }
type Options struct {
LogEncoding string
LogLevel string
Expand Down
4 changes: 2 additions & 2 deletions runtime/patch/patch.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ import (
// return ctrl.Result{}, client.IgnoreNotFound(err)
// }
//
// // Initialize the patch helper
// // Initialise the patch helper
// patchHelper, err := patch.NewHelper(obj, r.Client)
// if err != nil {
// return ctrl.Result{}, err
Expand Down Expand Up @@ -127,7 +127,7 @@ type Helper struct {
isConditionsSetter bool
}

// NewHelper returns an initialized Helper.
// NewHelper returns an initialised Helper.
func NewHelper(obj client.Object, crClient client.Client) (*Helper, error) {
// Get the GroupVersionKind of the object,
// used to validate against later on.
Expand Down
2 changes: 1 addition & 1 deletion runtime/pprof/pprof.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ var endpoints = map[string]http.Handler{
// os.Exit(1)
// }
// pprof.SetupHandlers(mgr, log)
// }
// }
func SetupHandlers(mgr ctrl.Manager, log logr.Logger) {
// Only set the fraction if there is no existing setting
if runtime.SetMutexProfileFraction(-1) == 0 {
Expand Down
2 changes: 1 addition & 1 deletion runtime/testenv/testenv.go
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ func WithCRDPath(path ...string) Option {
// New creates a new environment spinning up a local api-server.
//
// NOTE: This function should be called only once for each package you are running tests within, usually the environment
// is initialized in a suite_test.go or <package>_test.go file within a `TestMain` function.
// is initialised in a suite_test.go or <package>_test.go file within a `TestMain` function.
func New(o ...Option) *Environment {
opts := options{}
for _, apply := range o {
Expand Down

0 comments on commit 9301197

Please sign in to comment.