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

improve documentation of ephemeral events #1284

Merged
merged 3 commits into from Nov 17, 2022

Conversation

uhoreg
Copy link
Member

@uhoreg uhoreg commented Oct 12, 2022

I'm not entirely sure if what I've done here is exactly right, but I think that we need to define ephemeral events in one spot, and then just use the "ephemeral" terminology instead of saying "events that aren't persisted e.g. typing". Opinions on whether this PR looks good, or whether there's a better place to define it, are welcome.

Addresses part of #136

Preview: https://pr1284--matrix-spec-previews.netlify.app

@richvdh
Copy link
Member

richvdh commented Oct 13, 2022

I am unenthusiastic, for the reasons set out in #897 (though as @jplatte notes, m.receipt and m.typing are less egregious than some).

I'd really prefer to see m.receipt and m.typing called out as particular cases in the /sync documentation, rather than mixing them in with the generic "events" documentation.

@uhoreg
Copy link
Member Author

uhoreg commented Oct 18, 2022

I've updated the PR so that they're listed in the /sync documentation, and the other place that discusses them refers to there.

@uhoreg
Copy link
Member Author

uhoreg commented Nov 16, 2022

Huh. Should have pressed the "Ready for review" button earlier. :-/

@uhoreg uhoreg marked this pull request as ready for review November 16, 2022 23:45
@uhoreg uhoreg requested a review from a team as a code owner November 16, 2022 23:45
Copy link
Member

@richvdh richvdh left a comment

Choose a reason for hiding this comment

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

lgtm

@richvdh richvdh merged commit 2fcc92c into matrix-org:main Nov 17, 2022
clokep pushed a commit to clokep/matrix-spec that referenced this pull request May 3, 2023
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

2 participants