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.

Sign up for GitHub

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

Jump to bottom

code: Clarify StartHeight message requirement in app-channel documentation #832

Open
3 tasks
romac opened this issue Feb 5, 2025 · 0 comments
Open
3 tasks

code: Clarify StartHeight message requirement in app-channel documentation #832

romac opened this issue Feb 5, 2025 · 0 comments
Labels
code Code/implementation related documentation Improvements or additions to documentation
Milestone
Phase 5

Comments

@romac
Copy link
Member

romac commented Feb 5, 2025

Summary

The current documentation states that the application "MAY" send a ConsensusMsg::StartHeight, but this is unclear and potentially problematic since stalling is the only alternative.

malachite/code/crates/app-channel/src/msgs.rs

Line 140 in 614a46c

/// In response to this message, the application MAY send a [`ConsensusMsg::StartHeight`]

Action items

  • Change documentation from "MAY" to "MUST" or "SHOULD"
  • Explicitly document what happens if the app doesn't reply
  • Update relevant code comments and documentation
@romac romac added code Code/implementation related documentation Improvements or additions to documentation labels Feb 5, 2025
@romac romac added this to the Phase 5 milestone Feb 5, 2025
@romac romac changed the title code: Clarify StartHeight message requirement in app-channel documentation code: Clarify StartHeight message requirement in app-channel documentation Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
code Code/implementation related documentation Improvements or additions to documentation
Projects
None yet
Milestone
Phase 5
Development

No branches or pull requests
1 participant
@romac