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

Document that the spec uses RFC 2119 #1928

Merged
merged 3 commits into from
Aug 15, 2024
Merged

Conversation

HarHarLinks
Copy link
Contributor

@HarHarLinks HarHarLinks commented Aug 12, 2024

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

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>
@HarHarLinks HarHarLinks requested a review from a team as a code owner August 12, 2024 16:28
@HarHarLinks
Copy link
Contributor Author

HarHarLinks commented Aug 12, 2024

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>
Copy link
Member

@richvdh richvdh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some minor edits

Comment on lines 102 to 105
### 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.
Copy link
Member

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:

Suggested change
### 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?

Copy link
Contributor Author

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?

Suggested change
### 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.

Copy link
Member

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.

content/_index.md Outdated Show resolved Hide resolved
content/_index.md Outdated Show resolved Hide resolved
Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>
Copy link
Member

@richvdh richvdh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks!

@richvdh richvdh merged commit dc017c2 into matrix-org:main Aug 15, 2024
12 checks passed
@zecakeh zecakeh mentioned this pull request Sep 5, 2024
41 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document that the spec uses RFC 2119
2 participants