matrix-org / matrix-org/matrix-spec

Spec refers to EDUs and account data as "events"

Open
#897 9 comments 1 reaction 0 assignees View on GitHub
clarification
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

The C-S spec refers to things like [`m.receipt`](https://spec.matrix.org/unstable/client-server-api/#mreceipt) and [`m.typing`](https://spec.matrix.org/unstable/client-server-api/#mtyping), and various bits of account data as "events". I think this is confusing - it gives the impression that such objects can appear in a room timeline, which is not the case.

Contributor guide

Open the contributing guide

Research direction

Search the Client-Server specification for uses of “events” describing m.receipt, m.typing, and account data, starting from the linked sections. Check how the specification distinguishes room-timeline events from EDUs and account data. Done means the terminology is corrected consistently without implying these objects can appear in a room timeline.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.