-
-
Notifications
You must be signed in to change notification settings - Fork 97
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
Document that the spec uses RFC 2119 #1928
Conversation
Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>
could you clarify where I should put the newsfragment for a change to the index? Update: https://matrix.to/#/#matrix-spec:matrix.org suggests adding it to all. |
Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
some minor edits
content/_index.md
Outdated
### Bindingness of requirements | ||
|
||
As a standards document, the Matrix Spec needs to signify the bindingness of the | ||
individual features, APIs, procedures, or other requirements it describes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Bindingness" is rather an awkward word!
Can we just say something like:
### Bindingness of requirements | |
As a standards document, the Matrix Spec needs to signify the bindingness of the | |
individual features, APIs, procedures, or other requirements it describes. | |
### Use of RFC2119 keywords |
... and omit the first paragraph, which I don't think adds much value?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried to be more generic and may have ended up with a mangled Germenglish version. How do you think about something slightly more general and introductory than jumping straight to RFC 2119 in the title?
### Bindingness of requirements | |
As a standards document, the Matrix Spec needs to signify the bindingness of the | |
individual features, APIs, procedures, or other requirements it describes. | |
### Requirement levels |
I'm slightly confused by the spelling in your proposal: Is it correct that contrary to MSCs, RFCs use a space before the number? RFC 2119 does where it references itself.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm slightly confused by the spelling in your proposal: Is it correct that contrary to MSCs, RFCs use a space before the number?
No, that's just me being a crank. The space is correct.
Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks!
Contributed with my community hat on.
I added it to the index because the index itself already starts using RFC 2119 language in section 3.
Pull Request Checklist
Resolves #1927
Preview: https://pr1928--matrix-spec-previews.netlify.app