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

Create deprecatedjson from mdn web #884

Merged
merged 9 commits into from
Dec 11, 2020
Merged

Create deprecatedjson from mdn web #884

merged 9 commits into from
Dec 11, 2020

Conversation

ShuiRuTian
Copy link
Contributor

This is the first step to fix microsoft/TypeScript#39514.

Now mostly use MDN message.

@ShuiRuTian
Copy link
Contributor Author

ShuiRuTian commented Jul 16, 2020

Some QA:

  1. Q: why deprecated.json added a lot of api, but in d.ts only change 6 lines?
    A: Some apis in deprecated.json does not exist in d.ts.
    And (we have come to code details) WebIdl.typedefs does not have "comment", it could only be marked as "deprecated". This is indeed could be improved.
    But, in the other way, it is strange,
    for example, there is "MouseWheelEvent": "Do not use this interface for wheel events.Like MouseScrollEvent, this interface is non-standard and deprecated. It was used in non-Gecko browsers only. Instead use the standard WheelEvent.\n",
    And, now come to d.ts, type MouseWheelEvent = WheelEvent, so is there really difference?

  2. Q: Why use mdn rather than W3C?
    A: Usually W3C give some more detail messages, but it not have uniform fotmat and I am not familiar with it, which make it diffcult to extract which type is deprecated and the relative info.

Welcome to ask more question! Or is there somewhere I do not explain clearly enough? Just feel free to share your opinion!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
manualAnalytics/README.md Outdated Show resolved Hide resolved
src/index.ts Outdated Show resolved Hide resolved
Copy link
Member

@sandersn sandersn left a comment

Choose a reason for hiding this comment

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

Looks good, but please remove manualAnalytics/* and related changes.

package.json Outdated Show resolved Hide resolved
@@ -281,6 +281,7 @@ __pycache__/
generated/
lib/
inputfiles/browser.webidl.json
.vscode
.vscode/*
!.vscode/launch.template.json
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this does anything here 👀

@@ -0,0 +1,33 @@
{
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't see any automatic generator for this file. Is this file handcrafted?

Copy link
Contributor Author

@ShuiRuTian ShuiRuTian Oct 17, 2020

Choose a reason for hiding this comment

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

No, it is created by a script. It is why I change the .gitignore file ---- I did add the template file, for running the script by vscode quickly.
But sandersn think this file would not update frequently and this file could be maintained manually like others. So I delete the script from the branch. You could see the previews for more info.

Copy link
Contributor

@orta orta left a comment

Choose a reason for hiding this comment

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

We think this makes sense as-is 👍🏻

@orta orta merged commit 07ea4e8 into microsoft:master Dec 11, 2020
@saschanaz
Copy link
Contributor

saschanaz commented Dec 11, 2020

MDN BCD provides deprecation flags (#915), and then we won't need this. 👀

It only provides flags without the notes, so maybe still valuable!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add @deprecated reasons in lib.dom.d.ts
5 participants