Skip to content

Commit

Permalink
Reword Completed doc
Browse files Browse the repository at this point in the history
  • Loading branch information
olim7t committed Dec 5, 2024
1 parent 5bbd6af commit 36a47f9
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions pkg/result/result_helper.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,13 @@ var _ error = reconcile.TerminalError(nil)
// // Possibly inspect the result (e.g. to set an error field in the status)
// return recResult.Output()
type ReconcileResult interface {
// Completed indicates that this result is *NOT* a [Continue].
// Completed indicates that the current iteration of the reconciliation loop is complete, and the top-level
// Reconcile() method should return [ReconcileResult.Output] to the controller runtime.
//
// In other words, it means that the current iteration of the reconciliation loop is complete, and the top-level
// Reconcile() method should return to the controller runtime (either with a success or terminal error that will
// stop the entire reconciliation loop, or a requeue or regular error that will trigger a retry).
// This returns true for a [Done] or terminal [Error] (where the output will stop the entire reconciliation loop);
// and for a [RequeueSoon] or regular [Error] (where the output will trigger a retry).
//
// This returns false for a [Continue].
Completed() bool
// Output converts this result into a format that the main Reconcile() method can return to the controller runtime.
//
Expand Down

0 comments on commit 36a47f9

Please sign in to comment.