-
Notifications
You must be signed in to change notification settings - Fork 2k
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
meta: Remove references to "version_added": true or null from compat data schema documentation #24257
Comments
|
This is already covered in #24174, which will be merged once the remaining usage of nonreal values is finally removed. As far as removing the mention of these values from the docs before they're fully removed from BCD, I do not think that updating the docs early is a good idea. While I'm all for finally getting rid of nonreal values (I'm leading the project after all!), they are still valid values, so we should document them and describe them while they're still present. Additionally, we're so close to getting rid of them all, so there's no need to remove the documentation early! |
Continued:
|
What type of issue is this?
Schema issue
What is the issue?
https://github.com/mdn/browser-compat-data/blob/main/schemas/compat-data-schema.md#the-__compat-object, https://github.com/mdn/browser-compat-data/blob/main/schemas/compat-data-schema.md#version_added, and https://github.com/mdn/browser-compat-data/blob/main/schemas/compat-data-schema.md#flags make references to
"version_added": null
and/or"version_added": true
.Looking at https://github.com/search?q=repo%3Amdn%2Fbrowser-compat-data+%22%5C%22version_added%5C%22%3A+null%22&type=code, explicit mention of
"version_added": null
has already been fully removed from the BCD, only being referenced in that documentation and in a test that checks it to be the default when compatibility data is not provided.Looking at https://github.com/search?q=repo%3Amdn%2Fbrowser-compat-data+%22%5C%22version_added%5C%22%3A+true%22&type=code,
"version_added": true
is only being used in 12 remaining files (outside the documentation page), and there has recently been a concerted effort to remove the remaining instances.It's also worth noting this is the only remaining document that mentions
"version_removed": true
: https://github.com/search?q=repo%3Amdn%2Fbrowser-compat-data+%22%5C%22version_removed%5C%22%3A+true%22&type=codeWhat behavior were you expecting?
The schema documentation shouldn't reference a deprecated way of indicating browser support. There's an argument to be made for not removing this until those other 12 files are updated, but I think it's a poor argument, as the documentation says it's only noting the "common possible support statements", and this support statement is no longer common.
What version(s) of BCD is the issue present in?
main
branchDo you have anything more you want to share?
No response
The text was updated successfully, but these errors were encountered: