ACT 2.4.6 atomic rule Update#2425
Conversation
This is work-in-progress still at its early stage, more examples will be added, some may be removed. Everything is open to discussion.
Updated the description and applicability of the heading relevance rule to clarify its requirements and scope.
Added authors to acknowledgments and clarified rule scope.
Updated the description for clarity and improved the explanation of the rule's evaluation criteria. Added sections on assumptions, limitations, and exceptions to provide more context.
Edits made until Passed example 6
❌ Deploy Preview for act-rules failed.
|
Examples section (work-in-progress) Text reviewed until Passed (situation D)
Updated comments in HTML examples for consistency by adding periods at the end of sentences.
Updated comments in HTML examples to remove unnecessary punctuation.
Clarified the definition of 'content' in relation to headings and corrected a comment in the passed example.
Updated the wording and structure of the rule to clarify the applicability and expectations regarding headings. Modified limitations and exceptions.
This will be the entire content, but not carefully reviewed yet. This is Draft 1.
The entire text is available. Fixing logical issues, adding or removing sentences.
Minor changes in the wording and in the ordering of the examples
|
Thanks for putting this together @grifare. Just as a reminder, the thing that kicked it off was that a heading shouldn't only have to describe the first thing after it. That's a real issue with the current rule. The reason we wrote it that way is we couldn't figure out how to say how much a heading should describe, or where a section actually ends. I do have to be straight with you about the big problem though. Your rule doesn't follow the ACT Rules Format or the style guide. We can't invent new sections or change how rules are written, like the whole "Situations A–F" thing, the "Limitations" bit, turning Expectation into a bulleted list, or writing test cases as prose instead of full HTML. What you've written is so fare removed from a valid ACT rules that I don't think we can do this with just inline comments on a pull request. This is all about the format. The ideas are a different story, and a bunch of them I like. Quick take on each: The "anything that functions as a heading" idea. I get the intent, but I think it makes the rule too complicated. It's really hard to say what has to be a heading. Usually the actual requirement is that content has a relationship, and a heading is one good way to do that but often not the only one. We can't just say "anything that looks like a heading". Sometimes a heading is a list item, sometimes it's a figcaption, sometimes a table caption, sometimes it's none of these and it should be. It's hard to say what an applicability like this means. If think this problem of "should it be a heading" is worth tackling, but I think that's done in a separate rule. Pulling content quality apart from other failures, the misleading-heading case, and the editorial-vs-accessibility line all seem reasonable. We just need a good spot for them. We usually do things like this through a definition, rather than a new section. That would be where I'd start. The one I'd push back on is making it subjective / human-only / test-to-pass. Rules should stay neutral on how they get tested. If a tool can do it, good on them, and full transparency, I'm building exactly that right now. Descriptiveness is something tools can test quite well these days. What I'd suggest: let's take the core problem, how much a heading should describe and where a section ends, and hash it out in a smaller PR first. We can look at what it means to be descriptive separately, and split the applicability idea into its own rule. Once we agree on direction the PR gets a lot easier to write. Let's discuss during an upcoming ACT call. |
|
<< Describe the changes >>
Closes issue(s):
Need for Call for Review:
<< choose one of the following and remove the rest >>
<< check Process Document on Call for Review >>
This can be merged with 1 approval << choose reason: editorial changes to website/test code, adding new contributor, other (explain). >>
This will not require a Call for Review << choose reason(s): editorial changes (including to the applicability, expectation or examples section), changes to assumptions, background, accessibility support, change to website/test code (not rule), other (explain). >>
This will require a 1 week Call for Review << small changes affecting a small number of examples, if in doubt do not use this. >>
This will require a 2 weeks Call for Review << new rule, or substantial changes affecting a large number of examples, if in doubt, use this. >>
Pull Request Etiquette
When creating PR:
developbranch (left side).After creating PR:
Rule,DefinitionorChore.When merging a PR:
How to Review And Approve