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

Fixing up doc vs BCD deprecation #10224

Closed
hamishwillee opened this issue May 3, 2021 · 5 comments
Closed

Fixing up doc vs BCD deprecation #10224

hamishwillee opened this issue May 3, 2021 · 5 comments
Labels
data:api 🐇 Compat data for Web APIs. https://developer.mozilla.org/docs/Web/API

Comments

@hamishwillee
Copy link
Collaborator

hamishwillee commented May 3, 2021

I've been through MDN and BCD attempting to match up deprecation info on web apis (theory being that ideally they should ideally match completely, but certainly not differ. MDN now matches BCD, where BCD has an entry.

  • The first section below are cases where BCD has a different entry/inconsistency. I presume we will want to fix these.
  • The second section is cases where there is no BCD entry. Wondering whether you think this is worth documenting in BCD to make everything sync up.

FYI @ddbeck

Marked as deprecated in MDN but not on BCD

Document.domain - in discussion #10348
SVGStylable - under investigation on MDN mdn/content#4782
SVGTransformable - #10354

#10356 - fixes
Window: vrdisplayblur event - marked as not deprecated (onvrdisplayblur marked as deprecated).
Window: vrdisplayconnect event - marked as not deprecated (onvrdisplayconnect marked as deprecated).
Window: vrdisplayactivate event - marked as not deprecated (onvrdisplayactivate marked as deprecated).
Window: vrdisplaydeactivate event- marked as not deprecated (on version marked as deprecated).
Window: vrdisplaydisconnect event - marked as not deprecated (on version marked as deprecated).
Window: vrdisplayfocus event - marked as not deprecated (on version marked as deprecated).
Window: vrdisplaypointerrestricted event - marked as not deprecated (on version marked as deprecated).
Window: vrdisplaypointerunrestricted event - marked as not deprecated (on version marked as deprecated).
Window: vrdisplaypresentchange event - marked as not deprecated (on version marked as deprecated).
Window: appinstalled event - Not documented. onappinstalled does exist and is marked as deprecated

WorkerGlobalScope.close() - Not documented. onclose does exist and is marked as deprecated - see #10416

Deprecated subfeatures where BCD has no record

UIEvent.cancelBubble

Still to look at:

@queengooborg queengooborg added the data:api 🐇 Compat data for Web APIs. https://developer.mozilla.org/docs/Web/API label May 3, 2021
@ddbeck
Copy link
Collaborator

ddbeck commented May 4, 2021

Thanks for opening this, @hamishwillee. It's partly related to #7709.

You're right that, for the APIs marked as deprecated in MDN but not on BCD, we ought to fix those. 👍 I'd welcome PRs to correct them. I'd prefer the PRs be grouped by topic. The ones where closely related features are already deprecated seem really straight forward to me (e.g., if one of <event>_event, on<event>, and, if applicable, the API for the event isn't like the others, then let's make them consistent with each other).

For the deprecated features without data in BCD, I suspect that many of them are not implemented at all. I don't think we should labor too hard over these. My recommendation for that would be to put the features into groups:

  1. At least one of Chrome, Firefox, or Safari supports the feature (i.e., the interface is exposed or a property is in the prototype—we don't need to find out of it actually works). @ me if you want pointers on how to do this.
  2. The feature is in a contemporary specification. The MDN pages themselves ought to lead in the direction of a relevant spec.
  3. Everything else.

Group 1 we should fix, groups 2 and 3 we should do a cursory check to find out if the features were ever supported (and, if in the last two years, add 'em). For groups 2 and 3, we shouldn't spend more than a couple of minutes searching the Chromium, Gecko, and WebKit mirror repos before moving on.

@hamishwillee
Copy link
Collaborator Author

Thanks @ddbeck . Kind of what I suspected. I'll start on these then.

@OnkarRuikar
Copy link
Contributor

OnkarRuikar commented Aug 14, 2022

We've started updating BCD info in mdn/content in this PR series.


Regarding deprecated features in the doc but not deprecated in BCD, I've updated remaining such 23 cases in BCD.
If you still find any case then let me know.

All the cases mentioned in the opening post of this issue either

  • got updated in BCD
  • the documents got deleted
  • there are no entries for the deprecated features in BCD

I think we can mark this issue resolved.

@hamishwillee
Copy link
Collaborator Author

@OnkarRuikar - I agree. Also, thanks for tidying this up. Would be good if we could automate keeping them in sync at some point.

@OnkarRuikar
Copy link
Contributor

Would be good if we could automate keeping them in sync at some point.

After we complete the PR series, I'll sync BCD as part of the Daily markdownlint PRs.

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

No branches or pull requests

4 participants