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

Auto Conformance section - words are not complete #927

Closed
riannella opened this issue Aug 31, 2016 · 5 comments
Closed

Auto Conformance section - words are not complete #927

riannella opened this issue Aug 31, 2016 · 5 comments

Comments

@riannella
Copy link

Respec auto adds the following Conformance section wording:

"The key words may, must, optional, and required are to be interpreted as described in [RFC2119]."

However, RFC2119 recommends a slightly different set of terms, and we repeat the same duplicates:

  • May is the same as Optional
  • Must is the same as Required

We also do not include any prohibitive terms.

We should consider updating this text to read:

"The key words must (or required), must not, should, should not, and may (or optional) are to be interpreted as described in [RFC2119]."

@marcoscaceres
Copy link
Member

This change seems ok to me. At some point, I'd like to make this smarter and only include the set of keywords that actually appear in the document.

@halindrome
Copy link
Contributor

Actually, it already only includes the terms that are used in the document.

On Tue, Aug 30, 2016 at 9:41 PM, Marcos Cáceres notifications@github.com
wrote:

This change seems ok to me. At some point, I'd like to make this smarter
and only include the set of keywords that actually appear in the document.


You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
#927 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AAfx8Js3E6Iq7qdkpxKJCL6DHiI--NhDks5qlOncgaJpZM4JxK-x
.

Shane McCarron
halindrome@gmail.com

@marcoscaceres
Copy link
Member

We are so awesome :)

@marcoscaceres
Copy link
Member

Ok, but then we must have a bug if @riannella's terms are not showing up.

@riannella's, what's the spec text that you have that is currently not showing up, so I can create a test case for it.

@riannella
Copy link
Author

Nope - it is working as specified...I just added a "must not" and it then appeared in the conformance section (magic!) (I should hit re-load more often!)
So it is working fine...
(Closing this issue)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants