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

Cannot use 2119 terms in notes #240

Closed
annevk opened this issue Aug 24, 2016 · 3 comments
Closed

Cannot use 2119 terms in notes #240

annevk opened this issue Aug 24, 2016 · 3 comments
Assignees

Comments

@annevk
Copy link
Member

annevk commented Aug 24, 2016

Happens at https://w3c.github.io/browser-payment-api/#dfn-value and maybe elsewhere.

@halindrome
Copy link
Contributor

The "should" in that note is not a 2119 term (in that it is not annotated as a 2119 term). It is just the common English usage of the word. 2119 terms in this and other respec documents are always in uppercase and always annotated with class "2119".

As an aside, this way of indicating that it is a 2119 term may be insufficient from an accessibility perspective. I wonder if there shouldn't be a more explicit accessible name so that screen readers have better guidance. @joanmarie or @marcoscaceres do you have an opinion?

@annevk
Copy link
Member Author

annevk commented Aug 24, 2016

It does not have to be annotated for it to be one.

@marcoscaceres
Copy link
Member

I don't have an opinion re: accessibility, but I do share @annevk's concerns about RFC2119 terms in non-normative text: It can lead to unintentional confusion, particularly because a lot of people (both devs and implementers) end up relying on notes to understand the spec text so they can take the "should" as RFC2119 SHOULD and so on.

adrianba added a commit to adrianba/browser-payment-api that referenced this issue Sep 16, 2016
adrianba added a commit that referenced this issue Sep 16, 2016
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

4 participants