Skip to content

Add OPTIONAL to conformace section #1184

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

Closed
awoie opened this issue Jul 5, 2023 · 2 comments
Closed

Add OPTIONAL to conformace section #1184

awoie opened this issue Jul 5, 2023 · 2 comments

Comments

@awoie
Copy link
Contributor

awoie commented Jul 5, 2023

OPTIONAL is a normative word, but we were using the lowercase version of it (on purpose). We could also fix things by just using "OPTIONAL", as that's equivalent to "MAY".

@msporny According to the Conformance section, we only have the following:

The key words MAY, MUST, MUST NOT, RECOMMENDED, SHOULD, and SHOULD NOT in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.

I know that OPTIONAL is used in IETF RFCs but I couldn't find it in the paragraph above. Should we add OPTIONAL there too? Or what is the reason it was not added?

Originally posted by @awoie in #1181 (comment)

@msporny
Copy link
Member

msporny commented Jul 5, 2023

I know that OPTIONAL is used in IETF RFCs but I couldn't find it in the paragraph above. Should we add OPTIONAL there too? Or what is the reason it was not added?

That paragraph is auto-generated by ReSpec based on the normative RFC language used throughout the document. So, if you don't use a certain RFC term, it's not added to that paragraph. If we use "OPTIONAL" (in all caps) in the document, ReSpec will modify that paragraph I pointed to and will add the word automatically to that paragraph.

So, no reason to modify that particular paragraph, it'll auto-update if we use the OPTIONAL language in the places where we use lowercase "optional" today.

We should close this issue given that ReSpec auto-generates that paragraph, will do the right thing if we add the OPTIONAL RFC language anywhere in the spec, (and we have no control over that paragraph).

@awoie
Copy link
Contributor Author

awoie commented Jul 5, 2023

Closing issue based on @msporny reply.

@awoie awoie closed this as completed Jul 5, 2023
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

No branches or pull requests

2 participants