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 of "role" field of Taskprov peer aggregator is inconsistent #3109

Open
divergentdave opened this issue May 7, 2024 · 0 comments

Comments

@divergentdave
Copy link
Contributor

The initial schema migration has a comment that says the taskprov_peer_aggregators.role column is "the role of this aggregator relative to the peer", while the documentation comment on PeerAggregator::role() says "Retrieve the role of the peer." I think we are going to settle on the source code's interpretation of this field, thus the comment in the schema is wrong. Unfortunately, sqlx's migrations table includes a hash of this migration, so we can't just update the SQL script without some extra manual interventions in deployed environments. We should correct this the next time we make database breaking changes and combine down to one migration script.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant