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

Tweak PDU diagram demonstrating prev_events. #3340

Merged
merged 2 commits into from Aug 31, 2021

Conversation

dkasak
Copy link
Member

@dkasak dkasak commented Aug 16, 2021

This tweaks the example DAG at https://spec.matrix.org/unstable/server-server-api/#pdus to be simpler, with two linear event chains E4 -> E3 -> E2 -> E1 and E6 -> E5 -> E2 -> E1. The extremities of the DAG are now the first and only point in the DAG where multiple event parents occur.

Since the point of the diagram is to demonstrate this very situation, it's better didactically if there is only one such situation in the diagram.

Prompted by this discussion.

This tweaks the DAG to be simpler, with two linear event chains E4 -> E3
-> E2 -> E1 and E6 -> E5 -> E2 -> E1. The extremities of the DAG are now
the first and only point in the DAG where multiple event parents occur.
Since the point of the diagram is to demonstrate this very situation,
it's better didactically if there is only one such situation in the
diagram.
@dkasak
Copy link
Member Author

dkasak commented Aug 16, 2021

@anoadragon453: After simply removing the arrow on the left of E2, I noticed that the diagram might still be a bit confusing due to the lines merging just after E1.

So instead of only removing it, I also made the fork happen after E2 (instead of E1) and added one more event, which makes it clearer to me. Thoughts welcome.

Copy link
Member

@anoadragon453 anoadragon453 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, I'd say the new text still conveys the meaning, but is much clearer than the previous text.

Thanks for taking the time to sort that out!

@richvdh richvdh merged commit 9098719 into old_master Aug 31, 2021
richvdh pushed a commit that referenced this pull request Aug 31, 2021
This tweaks the DAG to be simpler, with two linear event chains E4 -> E3
-> E2 -> E1 and E6 -> E5 -> E2 -> E1. The extremities of the DAG are now
the first and only point in the DAG where multiple event parents occur.
Since the point of the diagram is to demonstrate this very situation,
it's better didactically if there is only one such situation in the
diagram.
afranke pushed a commit to afranke/matrix-doc that referenced this pull request Sep 1, 2021
This tweaks the DAG to be simpler, with two linear event chains E4 -> E3
-> E2 -> E1 and E6 -> E5 -> E2 -> E1. The extremities of the DAG are now
the first and only point in the DAG where multiple event parents occur.
Since the point of the diagram is to demonstrate this very situation,
it's better didactically if there is only one such situation in the
diagram.
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

Successfully merging this pull request may close these issues.

None yet

3 participants