Skip to content

chore: update readme #1995

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

Merged
merged 1 commit into from
Apr 24, 2025
Merged

chore: update readme #1995

merged 1 commit into from
Apr 24, 2025

Conversation

Bashamega
Copy link
Contributor

I have updated it because it was misleading

Copy link
Contributor

Thanks for the PR!

This section of the codebase is owned by @saschanaz - if they write a comment saying "LGTM" then it will be merged.

@@ -86,8 +86,8 @@ If you are familiar with Web IDL, you may also want to check whether the upstrea
- `addedTypes.jsonc`: types that should exist but are missing from the spec data.
- `overridingTypes.jsonc`: types that are defined in the spec but have TypeScript-friendly modifications in the json files.
- `removedTypes.jsonc`: types that are defined in the spec but should be removed.
- `comments.json`: comment strings to be embedded in the generated .js files.
- `deprecatedMessage.json`: the reason why one type is deprecated. The reason why it is a separate file rather than merge in comment.json is mdn/apiDescriptions.json would also possibly be deprecated.
- `comments.json`: comment strings to be embedded in the generated .d.ts files.
Copy link
Contributor

Choose a reason for hiding this comment

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

(I think this is mostly deprecated after your MDN patch. We should consider removing it)

@saschanaz
Copy link
Contributor

LGTM

Copy link
Contributor

There was an issue merging, maybe try again saschanaz. Details

@jakebailey jakebailey merged commit 7ca5f39 into microsoft:main Apr 24, 2025
7 checks passed
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.

3 participants