Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for Finalizers does not return error #590

Closed
weters opened this issue Feb 5, 2019 · 3 comments
Closed

Documentation for Finalizers does not return error #590

weters opened this issue Feb 5, 2019 · 3 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation.

Comments

@weters
Copy link
Contributor

weters commented Feb 5, 2019

In the using_finalizers.md page of the kubebuilder book, the example returns a nil error when an error occurs.

I think it should be the following instead since they both should requeue the request, but actually returning an error when an error occurs seems like it's the more correct solution.

                        if err := r.Update(context.Background(), instance); err != nil {
-                               return reconcile.Result{Requeue: true}, nil
+                               return reconcile.Result{}, err
                        }
weters added a commit to weters/kubebuilder that referenced this issue Feb 5, 2019
k8s-ci-robot added a commit that referenced this issue Feb 5, 2019
#590 - Update documentation for Finalizers to return an explicit error
@droot
Copy link
Contributor

droot commented Feb 6, 2019

The PR is merged, so closing this.

@droot droot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. kind/documentation Categorizes issue or PR as related to documentation. and removed sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Feb 6, 2019
@justinsb
Copy link
Contributor

/close

(I presume)

@k8s-ci-robot
Copy link
Contributor

@justinsb: Closing this issue.

In response to this:

/close

(I presume)

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

4 participants