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

Room version grammar is inconsistent #1408

Closed
turt2live opened this issue Jan 18, 2023 · 4 comments · Fixed by #1422
Closed

Room version grammar is inconsistent #1408

turt2live opened this issue Jan 18, 2023 · 4 comments · Fixed by #1422
Labels
A-Room-spec Something to do with the room version specifications clarification An area where the expected behaviour is understood, but the spec could do with being more explicit

Comments

@turt2live
Copy link
Member

Link to problem area: https://spec.matrix.org/v1.5/rooms/#room-version-grammar

Issue

Room versions MUST NOT be empty and SHOULD contain only the characters a-z, 0-9, ., and -.

but then we go on to describe a grammar which doesn't honour the "SHOULD": is it legal to put emoji (for example) in room versions or not?

@turt2live turt2live added clarification An area where the expected behaviour is understood, but the spec could do with being more explicit A-Room-spec Something to do with the room version specifications labels Jan 18, 2023
@richvdh
Copy link
Member

richvdh commented Jan 18, 2023

is it legal to put emoji (for example) in room versions or not?

what? no! why would it be?

@turt2live
Copy link
Member Author

"SHOULD" implies the grammar is at most a suggestion.

@richvdh
Copy link
Member

richvdh commented Jan 19, 2023

for links, afaict this wording was introduced by matrix-org/matrix-spec-proposals#1773

@turt2live
Copy link
Member Author

ftr, this appears to have actually come from matrix-org/matrix-spec-proposals#1516 which links off to the MSC's google doc: https://docs.google.com/document/d/1urKgReoHqxX8R_XtySB17dPi-DZcKhqTEL2_s895Wz0/edit

That doc says:

It is recommended that version strings are limited to the characters a-z, 0-9, . and -.

At the time, the MSC process was still very new and being figured out, so I can believe it was a misunderstanding that "It is recommended" was treated as a SHOULD instead of a recommendation to the SCT. Ie: it could feasibly be reworded to say "It is recommended that [the Spec Core Team consider] version strings be limited to...".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Room-spec Something to do with the room version specifications clarification An area where the expected behaviour is understood, but the spec could do with being more explicit
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants