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

Fix: RFC 2119 link #262

Merged
merged 1 commit into from
Feb 10, 2022
Merged

Fix: RFC 2119 link #262

merged 1 commit into from
Feb 10, 2022

Conversation

ax3l
Copy link
Member

@ax3l ax3l commented Jan 12, 2022

The link to IETF RFC 2119 is broken.

This adds a new link and changes the spelling of keywords to lowercase.

The link to IETF RFC 2119 is broken.

This adds a new link and changes the spelling of keywords to
lowercase.
@ax3l ax3l added the revision change backwards-compatible, stylistic change (e.g. typos) label Jan 12, 2022
@ax3l ax3l requested a review from RemiLehe January 24, 2022 18:32
@s9105947
Copy link

Is there a specific reason to break with the corresponding BCP 14, which consists of RFC 2119 (keyword definition) + the 2017 update RFC 8174 (spelling clarification) which demand to always use ALLCAPS?

Personally I totally missed that the lower-case keywords are intended to follow RFC 2119 when first skimming the standard -- allthough I suppose the allcaps might be confusing when unfamiliar.

@ax3l
Copy link
Member Author

ax3l commented Jan 27, 2022

Yes, all-caps is just too weird to read and thus we never did that. Thus we re-define the keywords to lowercase now, otherwise same naming as indicated.

This whole definition is just a clarification, because many non-native (and some native) English speakers do not immediately see the difference between must and shall/should. This RFC nicely resolves this by clearly defining the meaning and difference/equivalence of such qualifiers.

@ax3l
Copy link
Member Author

ax3l commented Jan 27, 2022

@s9105947 is it ok if you add your name & affiliation to https://github.com/settings please ? :)
It's a bit hard otherwise for us to keep track who we email and chat on GitHub with 🙂

s9105947 added a commit to s9105947/openPMD-standard that referenced this pull request Jan 31, 2022
@RemiLehe RemiLehe merged commit 6d33f79 into openPMD:upcoming-2.0.0 Feb 10, 2022
@ax3l ax3l deleted the fix-rfc2119link branch February 16, 2022 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
revision change backwards-compatible, stylistic change (e.g. typos)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants