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

docs(HTMLElement.inert): add missing spec #11935

Closed
wants to merge 1 commit into from

Conversation

yinonov
Copy link

@yinonov yinonov commented Aug 7, 2021

Summary

Add missing spec link for HTMLElement.inert

Test results and supporting details

Related issues

@github-actions github-actions bot added the data:api Compat data for Web APIs. https://developer.mozilla.org/docs/Web/API label Aug 7, 2021
@ddbeck
Copy link
Collaborator

ddbeck commented Aug 17, 2021

Thanks for this PR, @yinonov. Also I see it's your first to the project—welcome!

It looks like this attribute isn't part of the HTML spec yet; see whatwg/html#4288. I'm not sure whether we ought to link to inertness spec section, especially since it explicitly says:

This section does not define or create any content attribute named "inert".

@Elchi3 @sideshowbarker do you have a take on what (if anything) ought to be used as the spec URL for this? I'm still uncertain on what constitutes a good and correct spec URL (apart from "passes the linter"). I could use some guidelines here (and in general).

@sideshowbarker
Copy link
Member

@Elchi3 @sideshowbarker do you have a take on what (if anything) ought to be used as the spec URL for this?

For cases where something isn’t actually in a published spec, we have not been adding an spec URL.

As noted above, the proposed specification text for inert only exists in a patch in a PR branch of the HTML spec repo. We’ve intentionally chosen not to link to that.

@sideshowbarker
Copy link
Member

…and to be clear: the section the https://html.spec.whatwg.org/multipage/interaction.html#inert-subtrees URL in the patch in this PR links to is not a definition of the inert attribute. So we definitely don’t want to use that URL

@ddbeck
Copy link
Collaborator

ddbeck commented Aug 17, 2021

@sideshowbarker

We’ve intentionally chosen not to link to that.

OK, great. In a case like this, what's the right move for the specifications section on the MDN page? Right now it's got the missing spec box.

@sideshowbarker
Copy link
Member

sideshowbarker commented Aug 17, 2021

OK, great. In a case like this, what's the right move for the specifications section on the MDN page? Right now it's got the missing spec box.

I think what @teoli2003 has been doing in those cases is just adding a sentence like “This feature is no part of any current specification.”, and then not including the {{Specification}} macro.

@yinonov
Copy link
Author

yinonov commented Aug 18, 2021

hey sorry for missing out the small (big 😁) letters in my reference. but t thanks for the detailed explanation here 👍

@ddbeck
Copy link
Collaborator

ddbeck commented Aug 18, 2021

@yinonov Thank you for taking the time to contribute here. Since there's no change to make to this file (yet), I'll close this PR. If you'd like to apply sideshowbarker's change to the content, then you can open a PR against https://github.com/mdn/content/blob/main/files/en-us/web/api/htmlelement/inert/index.html#L46-L48. Thank you again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data:api Compat data for Web APIs. https://developer.mozilla.org/docs/Web/API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants