matrix-org / matrix-org/matrix-spec

There are two different event structures called `m.typing`

Open
#1,241 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

clarification
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

Link to problem area: https://spec.matrix.org/v1.3/server-server-api/#typing-notifications and https://spec.matrix.org/v1.3/client-server-api/#typing-notifications

Issue

In the SSAPI we transmit the fact "User X is [not] typing in room R" m.typing.
In the CSAPI we transmit the fact "Users X, Y, Z are currently typing in room R" m.typing.

This is an opportunity for confusion. The expected structure for an event would ideally be determined by its type alone without any other context.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the SSAPI and CSAPI typing-notification sections linked in the issue and compare their two m.typing structures. Determine how the specification should avoid relying on context to distinguish them; done means the event type alone clearly identifies one structure.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.