Update documentation for Finalizers to return an explicit error (#590)

weters · Tom Peters · commit 0f0fc77442ea · 2019-02-05T17:08:50.000-05:00
diff --git a/docs/book/beyond_basics/using_finalizers.md b/docs/book/beyond_basics/using_finalizers.md
@@ -39,7 +39,7 @@ func (r *Reconciler) Reconcile(request reconcile.Request) (reconcile.Result, err
 		if !containsString(instance.ObjectMeta.Finalizers, myFinalizerName) {
 			instance.ObjectMeta.Finalizers = append(instance.ObjectMeta.Finalizers, myFinalizerName)
 			if err := r.Update(context.Background(), instance); err != nil {
-				return reconcile.Result{Requeue: true}, nil
+				return reconcile.Result{}, err
 			}
 		}
 	} else {
@@ -55,7 +55,7 @@ func (r *Reconciler) Reconcile(request reconcile.Request) (reconcile.Result, err
 			// remove our finalizer from the list and update it.
 			instance.ObjectMeta.Finalizers = removeString(instance.ObjectMeta.Finalizers, myFinalizerName)
 			if err := r.Update(context.Background(), instance); err != nil {
-				return reconcile.Result{Requeue: true}, nil
+				return reconcile.Result{}, err
 			}
 		}
 

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ func (r *Reconciler) Reconcile(request reconcile.Request) (reconcile.Result, err`
`39`	`39`	`if !containsString(instance.ObjectMeta.Finalizers, myFinalizerName) {`
`40`	`40`	`instance.ObjectMeta.Finalizers = append(instance.ObjectMeta.Finalizers, myFinalizerName)`
`41`	`41`	`if err := r.Update(context.Background(), instance); err != nil {`
`42`		`- return reconcile.Result{Requeue: true}, nil`
	`42`	`+ return reconcile.Result{}, err`
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`	`} else {`
`@@ -55,7 +55,7 @@ func (r *Reconciler) Reconcile(request reconcile.Request) (reconcile.Result, err`
`55`	`55`	`// remove our finalizer from the list and update it.`
`56`	`56`	`instance.ObjectMeta.Finalizers = removeString(instance.ObjectMeta.Finalizers, myFinalizerName)`
`57`	`57`	`if err := r.Update(context.Background(), instance); err != nil {`
`58`		`- return reconcile.Result{Requeue: true}, nil`
	`58`	`+ return reconcile.Result{}, err`
`59`	`59`	`}`
`60`	`60`	`}`
`61`	`61`