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

Add authoring should referring to tradeoffs for authors of exclusive accordions. #10003

Merged
merged 2 commits into from
Jan 10, 2024

Conversation

dbaron
Copy link
Member

@dbaron dbaron commented Dec 18, 2023

This adds a note to address the issues raised in
openui/open-ui#925


/interactive-elements.html ( diff )

@aardrian
Copy link

Brain melty and not familiar with WHATWG doc structure — what is happening here that couldn't be added in #9989?

@dbaron
Copy link
Member Author

dbaron commented Dec 19, 2023

I guess they could have been one PR, but they were triggered by different issues and they're at least a little bit distinct in my mind (#9899 is a little more specific to a11y whereas I think this one is more generally about usability).

@@ -60180,6 +60180,12 @@ interface <dfn interface>HTMLDetailsElement</dfn> : <span>HTMLElement</span> {
a member of. Opening one member of this group causes other members of the group to close. If the
attribute is specified, its value must not be the empty string.</p>

<p class="note">Before using this feature, authors <!--non-normative-->should consider whether
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to either be an authoritative "should" in a non-note, or it needs to be rephrased as not using the magic "should" keyword. I'm unsure which you are going for, but disabling the linter is not the right way to go.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I've revised it to be a normative author-facing should. (That wasn't what I was initially planning, but I guess the fact that I really do want to use the word "should" suggests that that's probably what I meant.)

@dbaron dbaron changed the title Add note about tradeoffs for authors of exclusive accordions. Add authoring should referring to tradeoffs for authors of exclusive accordions. Jan 9, 2024
@domenic domenic merged commit 0c214e6 into whatwg:main Jan 10, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

3 participants