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.

Sign up for GitHub

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

Jump to bottom

eslint-plugin-jsdoc: Use TypeScript recommendations #21556

Merged
merged 11 commits into from
Dec 13, 2023
Merged

eslint-plugin-jsdoc: Use TypeScript recommendations #21556

merged 11 commits into from
Dec 13, 2023

Conversation

queengooborg
Copy link
Contributor

This PR switches the JSDoc plugin to use the TypeScript recommendations instead of the regular ones, since we're using TypeScript.

Missing descriptions are generated with the help of GitHub Copilot.

@github-actions github-actions bot added infra Infrastructure issues (npm, GitHub Actions, releases) of this project linter Issues or pull requests regarding the tests / linter of the JSON files. bulk_update An update to a mass amount of data, or scripts/linters related to such changes scripts Issues or pull requests regarding the scripts in scripts/. merge conflicts 🚧 This PR needs to merge latest "main" branch to resolve a merge conflict or other issue. labels Dec 9, 2023
@github-actions GitHub Actions
Copy link

This pull request has merge conflicts that must be resolved before it can be merged.

@github-actions github-actions bot added merge conflicts 🚧 This PR needs to merge latest "main" branch to resolve a merge conflict or other issue. and removed merge conflicts 🚧 This PR needs to merge latest "main" branch to resolve a merge conflict or other issue. labels Dec 10, 2023
@github-actions GitHub Actions
Copy link

This pull request has merge conflicts that must be resolved before it can be merged.

@github-actions github-actions bot removed the merge conflicts 🚧 This PR needs to merge latest "main" branch to resolve a merge conflict or other issue. label Dec 10, 2023
@github-actions github-actions bot added the merge conflicts 🚧 This PR needs to merge latest "main" branch to resolve a merge conflict or other issue. label Dec 10, 2023
@github-actions GitHub Actions
Copy link

This pull request has merge conflicts that must be resolved before it can be merged.

@github-actions github-actions bot removed the merge conflicts 🚧 This PR needs to merge latest "main" branch to resolve a merge conflict or other issue. label Dec 10, 2023
@github-actions github-actions bot added the merge conflicts 🚧 This PR needs to merge latest "main" branch to resolve a merge conflict or other issue. label Dec 12, 2023
@github-actions GitHub Actions
Copy link

This pull request has merge conflicts that must be resolved before it can be merged.

@github-actions github-actions bot removed the merge conflicts 🚧 This PR needs to merge latest "main" branch to resolve a merge conflict or other issue. label Dec 12, 2023
@Elchi3
Copy link
Member

Elchi3 commented Dec 12, 2023

The majority of the change here remove types from comments, right?

 * @param {string[]} dirs The directories to load
 * @returns {object} All of the browser compatibility data

becomes

 * @param dirs The directories to load
 * @returns All of the browser compatibility data

Is that what we want?

@queengooborg
Copy link
Contributor Author

Since we're using TypeScript, we already specify types, and in a much more succinct way that ensures we don't/can't misdefine the types. So, yes!

Elchi3
Elchi3 approved these changes Dec 13, 2023
View reviewed changes
Copy link
Member

@Elchi3 Elchi3 left a comment

Choose a reason for hiding this comment

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

Okay, I have no strong feelings about the comments either.

@Elchi3 Elchi3 merged commit 568fde2 into main Dec 13, 2023
9 checks passed
@Elchi3 Elchi3 deleted the jsdoc-typescript branch December 13, 2023 09:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Elchi3 Elchi3 Elchi3 approved these changes

Assignees
No one assigned
Labels
bulk_update An update to a mass amount of data, or scripts/linters related to such changes infra Infrastructure issues (npm, GitHub Actions, releases) of this project linter Issues or pull requests regarding the tests / linter of the JSON files. scripts Issues or pull requests regarding the scripts in scripts/.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@queengooborg @Elchi3