mdn / mdn/browser-compat-data

"Only supported for HTMLDocument" notes inconsistently applied

Open
#10,682 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

data:api
Dominant language
JSON
Stars
5.8k
Forks
2.6k
Avg merge
1d 21h
Merged PRs (30d)
186

Description

https://github.com/mdn/browser-compat-data/issues/6839 fixed a bunch of entries for things that have been moved from HTMLDocument to Document, but there are still lots of APIs which were once on HTMLDocument which haven't gotten this treatment.

https://software.hixie.ch/utilities/js/live-dom-viewer/?saved=9330 is a test for all the entries that are currently in Document.json. As an example document.head seems to have been moved from HTMLDocument to Document in Firefox 61.

This is fairly well suited to systematic testing, but https://mdn-bcd-collector.appspot.com/ doesn't generate the variant tests that would be needed to do this. It's also doubtful that it's worth automating, since it would be fixed once and then not need any further testing.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the entries in Document.json and use the linked live DOM viewer test to check APIs that moved from HTMLDocument to Document, such as document.head. Compare the existing "Only supported for HTMLDocument" notes across those entries and update the inconsistent ones; the linked collector does not generate the needed variant tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.