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

Inline {{aggregation-job-validation}} into the sections that reference it #473

Closed
tgeoghegan opened this issue Jun 14, 2023 · 0 comments · Fixed by #485
Closed

Inline {{aggregation-job-validation}} into the sections that reference it #473

tgeoghegan opened this issue Jun 14, 2023 · 0 comments · Fixed by #485
Labels

Comments

@tgeoghegan
Copy link
Collaborator

{{aggregation-job-validation}} is referenced from the leader initialization and leader continuation sections. We did this to "factor out" common bits of protocol logic into a single place. However it only contains a single requirement, so on balance it probably does more harm to readability than it does improve maintainability of the document. We should inline that single bullet point into the sections that reference it.

See previous discussion.

tgeoghegan added a commit that referenced this issue Jun 27, 2023
The section describing how the Leader validates an `AggregationJobResp`
only contained a single criteria, and referring to it from multiple
places made it unnecessarily complicated. We now simply restate the
singular requirement in two sections, which should make this more clear
for implementers.

Resolves #473
cjpatton pushed a commit that referenced this issue Jul 4, 2023
The section describing how the Leader validates an `AggregationJobResp`
only contained a single criteria, and referring to it from multiple
places made it unnecessarily complicated. We now simply restate the
singular requirement in two sections, which should make this more clear
for implementers.

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

Successfully merging a pull request may close this issue.

1 participant