Skip to content

Conversation

Elchi3
Copy link
Member

@Elchi3 Elchi3 commented Aug 26, 2025

This is a bit of a test PR to see if we could add spec_urls everywhere (especially for behavioral sub features).
Some things came up where we should probably agree on spec_url consistency for a few common sub features:

  • worker_support
  • iterable sub features (forEach, keys, values, iterator, etc)
  • secure_context_required
    I decided to use the spec_url for the interface itself, happy to hear other thoughts.

Also, I think when a sub aspect of e.g. a method is described then it is okay to link to the same spec section as the method. So, basically the sub feature gets the same spec_url as the parent feature.

I marked standard_track false for a few things: CSSPrimitiveValue, CSSValue, CSSValueList, DOMError, FeaturePolicy. Doesn't look like these will be going anywhere.

Fixes #27456.

@github-actions github-actions bot added data:api Compat data for Web APIs. https://developer.mozilla.org/docs/Web/API size:m [PR only] 25-100 LoC changed labels Aug 26, 2025
Copy link
Contributor

github-actions bot commented Aug 26, 2025

Tip: Review these changes grouped by change (recommended for most PRs), or grouped by feature (for large PRs).

},
"entries": {
"__compat": {
"spec_url": "https://webaudio.github.io/web-audio-api/#audioparammap",
Copy link
Contributor

Choose a reason for hiding this comment

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

Some exploratory thoughts:

  • Could we remove spec_urls identical to the parent in the built data.json? (This way, we can still validate, but keep the published data concise.)
  • What if we changed the data to spec: { url: "…" }, allowing spec: "inherit" and spec: { pr_url: "…" }? (Doesn't mean we have to change the published data.)

Copy link
Member Author

Choose a reason for hiding this comment

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

The goal for having a spec_url is to be sure that the BCD feature points to something that is real and standardized. We already have several BCD features pointing to the same spec_url. I don't understand why it would be desirable to introduce additional complexity (neither from the authoring side nor from the publishing side).
From a published data point of view, my sense is that always having a spec_url would be great for consumers. And if there isn't one, it means the feature is not specified anywhere. That goal is also formulated in #1531.

@caugner
Copy link
Contributor

caugner commented Aug 29, 2025

This is a bit of a test PR

Is it okay to merge?

@Elchi3
Copy link
Member Author

Elchi3 commented Aug 29, 2025

This is a bit of a test PR

Is it okay to merge?

Yes, thanks for taking a look! I will proceed with more additions like this given that no one seems to hate it :)

@caugner caugner marked this pull request as draft August 29, 2025 18:33
@caugner
Copy link
Contributor

caugner commented Aug 29, 2025

Let's mark as draft for now then, I'll happily go through the changes to double check once complete.

@github-actions github-actions bot added size:l [PR only] 101-1000 LoC changed and removed size:m [PR only] 25-100 LoC changed labels Sep 2, 2025
@Elchi3 Elchi3 changed the title Add more spec_urls; set some standard_tracks to false (APIs A-C) Add more spec_urls; set some standard_tracks to false (APIs A-E) Sep 2, 2025
@github-actions github-actions bot added the merge conflicts 🚧 This PR needs to merge latest "main" branch to resolve a merge conflict or other issue. label Sep 29, 2025
Copy link
Contributor

This pull request has merge conflicts that must be resolved before it can be merged.

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 merge conflicts 🚧 This PR needs to merge latest "main" branch to resolve a merge conflict or other issue. size:l [PR only] 101-1000 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

api.Document.execCommand - either mark as non-standard or add link to w3c draft
3 participants