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

"DOMTimeStamp": renamed to EpochTimeStamp #14667

Closed
simonvarey opened this issue Apr 4, 2022 · 6 comments · Fixed by #14675
Closed

"DOMTimeStamp": renamed to EpochTimeStamp #14667

simonvarey opened this issue Apr 4, 2022 · 6 comments · Fixed by #14675
Assignees
Labels
Content:WebAPI Web API docs

Comments

@simonvarey
Copy link
Contributor

MDN URL: https://developer.mozilla.org/en-US/docs/Web/API/DOMTimeStamp

What information was incorrect, unhelpful, or incomplete?

This page has a link to specification of DOMTimeStamp, but the linked page https://webidl.spec.whatwg.org no longer has a specification of DOMTimeStamp (as of 21 Mar 2022). I believe EpochTimeStamp has replaced DOMTimeStamp.

Specific section or headline?

Specification

What did you expect to see?

A page specifying DOMTimeStamp

Did you test this? If so, how?

Followed the link and searched the page.

MDN Content page report details
@github-actions github-actions bot added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Apr 4, 2022
@sideshowbarker
Copy link
Collaborator

Thanks for catching this and reporting it.

Given whatwg/webidl#1021: To whoever fixes this, what needs to happen is:

@sideshowbarker sideshowbarker added Content:WebAPI Web API docs help wanted If you know something about this topic, we would love your help! effort: medium This task is a medium effort. and removed needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Apr 4, 2022
@sideshowbarker sideshowbarker changed the title Issue with "DOMTimeStamp": DOMTimeStamp not defined in linked specification "DOMTimeStamp": renamed to EpochTimeStamp Apr 4, 2022
@hamishwillee
Copy link
Collaborator

@sideshowbarker @simonvarey It isn't this simple, as you will see from this discussion: #11675 - and in particular #11675 (comment) :

DOMTimeStamp originally referred to itself as a timestamp definition where specific details were covered in other specs (I think this was in WebIDL spec). It was removed from that spec. It was separately redefined in the high resolution time spec to be this epoctimestamp, with precise meaning. So my concern was that the redefinition might only work for this specific spec definition and not the definition in other specs.

In other words it is good to create EpochTimeStamp, which I did in https://developer.mozilla.org/en-US/docs/Web/API/EpochTimeStamp , but we were unsure if the DOMTimeStamp should simply redirect because it is mentioned in other specs which have their own definitions that do NOT map to EpochTimeStamp (at least yet).

Thoughts?

@sideshowbarker
Copy link
Collaborator

In other words it is good to create EpochTimeStamp, which I did in developer.mozilla.org/en-US/docs/Web/API/EpochTimeStamp , but we were unsure if the DOMTimeStamp should simply redirect because it is mentioned in other specs which have their own definitions that do NOT map to EpochTimeStamp (at least yet).

Thanks — OK I now see whatwg/webidl#1021 (comment)

I don’t really have a good suggestion about what to do here. I can see now that this problem was created for us due to DOMTimeStamp having been removed prematurely from the WebIDL spec — despite the fact that other specs are still referencing it. That was a spec mistake that should not have been made. But we can’t fix that.

But given all that, I don’t think we should remove or change the spec URL in our DOMTimeStamp article, because it’s actually the correct spec link: It points to where DOMTimeStamp should still exist in the WebIDL spec — until such time as there are no other specs referencing DOMTimeStamp, at which point we can be confident that we don’t need it in MDN any longer, and somebody can do the steps listed in #14667 (comment)

@hamishwillee
Copy link
Collaborator

I don't think we should change the URL, but we might add some context in https://developer.mozilla.org/en-US/docs/Web/API/DOMTimeStamp ?

For example a note

DOMTimeStamp has been removed from the IDL in the linked specification, but is referenced in other specifications. In the High performance timer specification DOMTimeStamp has been redefined as EpochTimeStamp.

@sideshowbarker
Copy link
Collaborator

I don't think we should change the URL, but we might add some context in developer.mozilla.org/en-US/docs/Web/API/DOMTimeStamp ?

For example a note

DOMTimeStamp has been removed from the IDL in the linked specification, but is referenced in other specifications. In the High performance timer specification DOMTimeStamp has been redefined as EpochTimeStamp.

Yes, adding that note would mitigate the problem and be sufficient for resolving this issue, I think

@sideshowbarker sideshowbarker added effort: small This task is a small effort. and removed effort: medium This task is a medium effort. labels Apr 4, 2022
@hamishwillee
Copy link
Collaborator

Done in #14675

@sideshowbarker sideshowbarker removed help wanted If you know something about this topic, we would love your help! effort: small This task is a small effort. labels Apr 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants