Improve the description of epoch end #534
Conversation
The previous description of when an epoch ends was a bit confusing. It mentioned that two conditions are needed for a block to be the last block of an epoch, but in reality only one of them matters, as one condition is implied by the other. This makes the descripion harder to parse - why are there two conditions, if only one of them matters? It can lead to some confusion. Let's improve the description to make it clearer and easier to understand. A diagram is also added for clarity. Refs: [zulip discussion](https://near.zulipchat.com/#narrow/stream/295558-pagoda.2Fcore/topic/When.20does.20an.20Epoch.20end.3F/near/422463251)
|
It looks like the existing version of The |
frol
added
WG-protocol
|
@near/wg-protocol Could you, please, review the changes? |
I'd appreciate a review, the PR is over a month old. |
There was a problem hiding this comment.
Looks good to me.
@jancionear, thanks for submitting this change. The diagram is quite helpful.
Co-authored-by: Marcelo Fornet <mfornet94@gmail.com>
|
Github says:
I guess it also needs a review from @near/nep-moderators before merging. |
|
@frol could you approve? |
There was a problem hiding this comment.
Sorry for the delay on my side.
@jancionear Thank you for the contribution and patience! 🙏
The previous description of when an epoch ends was a bit confusing. It mentioned that two conditions are needed for a block to be the last block of an epoch, but in reality only one of them matters, as one condition is implied by the other. This makes the descripion harder to parse - why are there two conditions, if only one of them matters? It can lead to some confusion.
Let's improve the description to make it clearer and easier to understand. A diagram is also added for clarity.
Refs: zulip discussion