matrix-org / matrix-org/matrix-spec
UserID type not used consistently
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**:
exemplary https://spec.matrix.org/v1.18/client-server-api/#molmv1curve25519-aes-sha2
**Issue**
Sometimes, the `type` of fields that are supposed to contain user IDs is given as `string`, and sometimes as `User ID`, with a link to https://spec.matrix.org/v1.18/appendices/#user-identifiers.
In the example above, this is especially noticeable, as it is the case for two fields right next to each other, but the issue persists throughout the spec.
This is confusing – is the use of different types intentional, and if so, what's the reason?
Otherwise, all user ID fields should probably have type [`User ID`](https://spec.matrix.org/v1.18/appendices/#user-identifiers).
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 linked M.olmv1Curve25519-AES-SHA2 example and compare adjacent fields typed as string or User ID. Search the specification for other user ID fields and determine whether the type should be normalized; done means the intended convention is applied consistently throughout the affected spec sections.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100