matrix-org / matrix-org/matrix-spec
knock_room_state is used in an example, but never explained properly
Nobody has claimed this yet.
- 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/client-server-api/#mroommember
Issue
One of the examples for m.room.member contains a knock_room_state field in unsigned, but this is not mentioned anywhere else. It seems similar to invite_room_state which is also only explained very briefly (not listed in one of the tables, just mentioned in the text), if it actually exists rather than just being an artifact that was never meant to enter the spec.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the m.room.member section at the linked Client-Server API page and inspect the example containing unsigned.knock_room_state. Compare its treatment with invite_room_state and check the surrounding specification text or tables for definitions. Done means the specification consistently documents the field or removes the unexplained example usage, with the intended status made clear.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100