Skip to content

Commit

Permalink
style(docs): clarify the Execute function comments across controllers
Browse files Browse the repository at this point in the history
Signed-off-by: Christian Stewart <christian@aperture.us>
  • Loading branch information
paralin committed Jun 4, 2024
1 parent 00fd08d commit 3884ddd
Show file tree
Hide file tree
Showing 9 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion bus/bridge/bridge.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ func (b *BusBridge) GetControllerInfo() *controller.Info {
return controller.NewInfo(ControllerID, Version, "forwards directives to bus")
}

// Execute executes the given controller.
// Execute executes the controller goroutine.
// Returning nil ends execution.
// Returning an error triggers a retry with backoff.
func (b *BusBridge) Execute(ctx context.Context) error {
Expand Down
2 changes: 1 addition & 1 deletion bus/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ func (c *BusController[T]) GetControllerInfo() *controller.Info {
return controller.NewInfo(c.controllerID, c.controllerVersion, c.controllerDescrip)
}

// Execute executes the given controller.
// Execute executes the controller goroutine.
func (c *BusController[T]) Execute(ctx context.Context) error {
return nil
}
Expand Down
2 changes: 1 addition & 1 deletion controller/callback/callback.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ func (c *CallbackController) HandleDirective(ctx context.Context, di directive.I
return nil, nil
}

// Execute executes the given controller.
// Execute executes the controller goroutine.
// Returning nil ends execution.
// Returning an error triggers a retry with backoff.
func (c *CallbackController) Execute(ctx context.Context) error {
Expand Down
2 changes: 1 addition & 1 deletion controller/configset/controller/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ func NewController(le *logrus.Entry, bus bus.Bus) (*Controller, error) {
}, nil
}

// Execute executes the given controller.
// Execute executes the controller goroutine.
// Returning nil ends execution.
// Returning an error triggers a retry with backoff.
func (c *Controller) Execute(ctx context.Context) error {
Expand Down
2 changes: 1 addition & 1 deletion controller/resolver/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ func (c *Controller) HandleDirective(ctx context.Context, di directive.Instance)
return nil, nil
}

// Execute executes the given controller.
// Execute executes the controller goroutine.
// Returning nil ends execution.
// Returning an error triggers a retry with backoff.
func (c *Controller) Execute(ctx context.Context) error {
Expand Down
2 changes: 1 addition & 1 deletion example/boilerplate/controller/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ func (c *Controller) HandleDirective(
return nil, nil
}

// Execute executes the given controller.
// Execute executes the controller goroutine.
// Returning nil ends execution.
// Returning an error triggers a retry with backoff.
func (c *Controller) Execute(ctx context.Context) error {
Expand Down
2 changes: 1 addition & 1 deletion example/hello-world/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ func (c *ToyController) HandleDirective(
return nil, nil
}

// Execute executes the given controller.
// Execute executes the controller goroutine.
// Returning nil ends execution.
// Returning an error triggers a retry with backoff.
func (c *ToyController) Execute(ctx context.Context) error {
Expand Down
2 changes: 1 addition & 1 deletion example/plugin-demo/demo-controller/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ func (c *Controller) HandleDirective(
return nil, nil
}

// Execute executes the given controller.
// Execute executes the controller goroutine.
// Returning nil ends execution.
// Returning an error triggers a retry with backoff.
func (c *Controller) Execute(ctx context.Context) error {
Expand Down
2 changes: 1 addition & 1 deletion plugin/loader/shared-library/filesystem/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ func NewController(le *logrus.Entry, bus bus.Bus, conf *Config) (*Controller, er
}, nil
}

// Execute executes the given controller.
// Execute executes the controller goroutine.
// Returning nil ends execution.
// Returning an error triggers a retry with backoff.
func (c *Controller) Execute(ctx context.Context) error {
Expand Down

0 comments on commit 3884ddd

Please sign in to comment.