-
Notifications
You must be signed in to change notification settings - Fork 251
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
Documenting consensus messages #48
Milestone
Comments
I would like to take this issue, although I will probably need some help in order to document things properly. Still, it would be a nice opportunity to understand consensus better. |
23 tasks
i assume, getting the doc actually generated depends on #17. |
stanislav-tkach
pushed a commit
to stanislav-tkach/exonum
that referenced
this issue
Feb 10, 2018
Apply new format and update travis script
stanislav-tkach
added a commit
to stanislav-tkach/exonum
that referenced
this issue
Feb 17, 2018
Test transaction business logic
stanislav-tkach
pushed a commit
to stanislav-tkach/exonum
that referenced
this issue
Apr 4, 2018
update link to exonum-client dependency
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
It was determined in #46 that consensus messages (e.g.,
Propose
) are not sufficiently documented for now. Each such message could be commented likeNote that consensus messages are slightly different from transaction messages defined by services; neither Processing, nor Generation sections can be straightforwardly translated for transaction messages (although these messages should probably be documented too). This is because tx message processing is encapsulated in the
execute()
method of the transaction (i.e., can be documented there); and there are no specific rules as to when ordinary tx messages are generated.Proposed solution: I think some documentation for consensus messages is needed both here and in general Exonum docs. Message descriptions here could be useful in order to verify that messages are processed and generated as intended without needing to consult an external source. And they can be copy-pasted to the general docs if necessary.
The text was updated successfully, but these errors were encountered: