element-hq / element-hq/element-web
Add a lint rule to require at least some docs if jsdoc is defined
Open
A-Documentation
Hacktoberfest
Help Wanted
O-Uncommon
S-Minor
T-Task
- Dominant language
- TypeScript
- Stars
- 13.5k
- Forks
- 2.8k
- PR merge metrics
- PR metrics pending
Description
The following is not helpful, for example:
```
/**
* @param {string} roomId
* @param {string} userId
* @param {string} reason Optional.
* @param {module:client.callback} callback Optional.
* @return {Promise} Resolves: TODO
* @return {module:http-api.MatrixError} Rejects: with an error response.
*/
```
This repeated a number of times through our code.
Contributor guide
Assessment
This issue has not been assessed yet.