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

Abstract role "Note" inconsistencies #1015

Closed
carmacleod opened this issue Jul 18, 2019 · 1 comment · Fixed by #1420
Closed

Abstract role "Note" inconsistencies #1015

carmacleod opened this issue Jul 18, 2019 · 1 comment · Fixed by #1420
Assignees
Labels
editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo
Milestone

Comments

@carmacleod
Copy link
Contributor

In the following sections describing abstract roles, it is clear that authors MUST NOT use them in content:

  • Abstract Roles

    Content authors MUST NOT use abstract roles because they are not implemented in the API binding.

  • List of Abstract Roles

    Authors MUST NOT use abstract roles in content.

However, the Note in the definition for each abstract role says "should not" instead of "MUST NOT":

Authors should not use this role in content.

Is there a reason for this inconsistency? Are "Notes" non normative? (and even if they are, wouldn't it be clearer to use "must not" in the Note?)

Another inconsistency:

  • the definition for input is missing the Note
@carmacleod carmacleod changed the title Abstract roles Abstract role "Note" inconsistencies Jul 18, 2019
@joanmarie joanmarie added this to the ARIA 1.2 milestone Jul 18, 2019
@carmacleod carmacleod self-assigned this Jul 18, 2019
@carmacleod
Copy link
Contributor Author

Remove text from Note, make consistent

@jnurthen jnurthen added the editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo label Nov 19, 2019
@jnurthen jnurthen modified the milestones: ARIA 1.2, ARIA 1.3 Nov 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants