search

electron / fiddle

:electron: 🚀 The easiest way to get started with Electron
https://electronjs.org/fiddle
MIT License
7.46k stars 692 forks source link

chore: convert JSDoc comments to TSDoc #1629

Closed dsanders11 closed 3 months ago

dsanders11 commented 3 months ago

Most of the "conversion" here is simply deleting @param and @returns which are only types, since they're redundant to the TS types, sometimes wrong, and TSDoc doesn't include types for obvious reasons.

eslint-plugin-tsdoc is disabled in test files due to usage of @jest-environment in some files, and it's unlikely there are going to be TSDoc comments in those files anyway.

coveralls commented 3 months ago

Coverage Status

coverage: 87.602%. remained the same when pulling 51a48a441c7b00bed89b2d59c38773490bdb6fe3 on chore/convert-jsdoc-to-tsdoc into f6d785d459af2e2d01bd0afc4cd04e6ae2ae530a on main.