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

FF89: Removal of events docs for DeviceLightEvent, DeviceProximityEvent, UserProximityEvent #4515

Merged
merged 3 commits into from Apr 27, 2021

Conversation

hamishwillee
Copy link
Collaborator

Docs work for #4308

The DeviceLightEvent, DeviceProximityEvent, UserProximityEvent events (and associated handlers) in window are removed in FF89, which was the last implementer of these APIs. This is primarily a privacy issue as discussed in https://bugzilla.mozilla.org/show_bug.cgi?id=1701824#c5

What this does remove the handler docs and all the event attribute docs. The remaining docs are then just the parent API and the event itself (which is what is linked). These remaining docs have the deprecated header, and a warning that they should not be used. Essentially there is still "just" enough docs to indicate how they are used and that they exist, but a lot of discouragement from doing so, and removal of these would be very trivial.

@hamishwillee hamishwillee requested review from a team as code owners April 27, 2021 06:36
@hamishwillee hamishwillee requested review from chrisdavidmills and removed request for a team April 27, 2021 06:36
@@ -3,22 +3,28 @@
slug: Web/API/Ambient_Light_Events
tags:
- Ambient Light
- Deprecated
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@chrisdavidmills FYI, this is here because the tag is what gives you the icons in the lists here https://developer.mozilla.org/en-US/docs/Web/API

We probably should get this ultimately from BCD too. In the meantime some cleanup required at some point to make these match the docs, and the BCD.

@github-actions
Copy link
Contributor

Preview URLs

Flaws

Note! 2 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/Ambient_Light_Events
Title: Ambient Light Events
on GitHub
Flaw count: 1

  • bad_bcd_links:
    • no explanation!

URL: /en-US/docs/Web/API/Window
Title: Window
on GitHub
Flaw count: 43

  • macros:
    • /en-us/docs/web/api/globalcrypto (url: /en-US/docs/Web/API/GlobalCrypto) does not exist
    • /en-us/docs/web/api/speechsynthesisgetter (url: /en-US/docs/Web/API/SpeechSynthesisGetter) does not exist
    • /en-us/docs/web/api/windowmodal (url: /en-US/docs/Web/API/WindowModal) does not exist
    • /en-us/docs/web/api/onerroreventhandlerforwindow (url: /en-US/docs/Web/API/OnErrorEventHandlerForWindow) does not exist
    • /en-us/docs/web/api/chromewindow (url: /en-US/docs/Web/API/ChromeWindow) does not exist
    • and 27 more flaws omitted
  • broken_links:
    • Can't resolve /en-US/docs/The_message_manager
    • Can't resolve /en-US/docs/Mozilla/Tech/XUL/Attribute/onpagehide
    • Can't resolve /en-US/docs/Mozilla/Tech/XUL/Attribute/onpageshow
  • bad_bcd_links:
    • no explanation!
    • no explanation!
    • no explanation!
    • no explanation!
    • no explanation!
    • and 3 more flaws omitted

URL: /en-US/docs/Web/API/DeviceProximityEvent
Title: DeviceProximityEvent
on GitHub
Flaw count: 3

  • bad_bcd_links:
    • no explanation!
    • no explanation!
    • no explanation!

URL: /en-US/docs/Web/API/UserProximityEvent
Title: UserProximityEvent
on GitHub
Flaw count: 1

  • bad_bcd_links:
    • no explanation!

External URLs

URL: /en-US/docs/Web/API/DeviceLightEvent
Title: DeviceLightEvent
on GitHub


URL: /en-US/docs/Web/API/Ambient_Light_Events
Title: Ambient Light Events
on GitHub


URL: /en-US/docs/Web/API/Proximity_Events
Title: Proximity Events
on GitHub


URL: /en-US/docs/Web/API/Window
Title: Window
on GitHub


URL: /en-US/docs/Web/API/DeviceProximityEvent
Title: DeviceProximityEvent
on GitHub

No external URLs

URL: /en-US/docs/Web/API/UserProximityEvent
Title: UserProximityEvent
on GitHub

No external URLs

Copy link
Contributor

@chrisdavidmills chrisdavidmills left a comment

Choose a reason for hiding this comment

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

All looks pretty reasonable to me.

@chrisdavidmills chrisdavidmills merged commit 9586311 into mdn:main Apr 27, 2021
@hamishwillee hamishwillee deleted the proximity_light branch May 3, 2021 01:07
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants