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

Document ReconcileResult type #1419

Open
olim7t opened this issue Sep 27, 2024 · 0 comments · May be fixed by #1463
Open

Document ReconcileResult type #1419

olim7t opened this issue Sep 27, 2024 · 0 comments · May be fixed by #1463
Assignees
Labels
documentation Improvements or additions to documentation refactoring

Comments

@olim7t
Copy link
Contributor

olim7t commented Sep 27, 2024

The ReconcileResult interface is widely used throughout our codebase, yet from this conversation it appears that there is some confusion around its usage.

Suggested tasks:

  • document the API: what each implementation means, and how a caller should typically handle a result coming back from a sub-component (I believe it should always be the same pattern outside of the main reconciliation method).
  • check that existing code conforms with that documentation. In particular, reconciliation.ReconcileObject() returns result.Done() when the reconciliation is successful, arguably it should be result.Continue().

┆Issue is synchronized with this Jira Story by Unito
┆Issue Number: K8OP-261

@olim7t olim7t added documentation Improvements or additions to documentation refactoring labels Sep 27, 2024
olim7t added a commit to olim7t/k8ssandra-operator that referenced this issue Nov 28, 2024
@olim7t olim7t linked a pull request Nov 28, 2024 that will close this issue
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation refactoring
Projects
No open projects
Status: No status
Development

Successfully merging a pull request may close this issue.

1 participant