Kubebuilder Book: confusing comment describing controller requeue
kind/documentationkind/feature
### What do you want to happen?
I want to preface by saying I am new to Kubebuilder and as such this issue may not really be that important.
I was going through the kubebuilder book and came across the line:
[cronjob_controller.go](https://github.com/kubernetes-sigs/kubebuilder/blob/5dead900137df5a127a822eaca1f71a75ef7ab74/docs/book/src/cronjob-tutorial/testdata/project/internal/controller/cronjob_controller.go#L664-L665)
```
// actually make the job...
job, err := constructJobForCronJob(&cronJob, missedRun)
if err != nil {
log.Error(err, "unable to construct job from template")
// don't bother requeuing until we get a change to the spec
return scheduledResult, nil
}
```
This code works fine but I feel like the comment could be improved for learning purposes. It seems like perhaps it might be better to say something like
```
// don't immediately requeue, wait till the next window since the spec needs to be fixed
```
Or something along those lines. If the maintainers agree that this is clearer, I would be happy to submit a PR with this change.
### Extra Labels
/kind documentation
0 条评论