mirror of
https://github.com/balena-io/etcher.git
synced 2025-07-27 21:26:38 +00:00
chore: improve JSDoc ESLint rules (#1147)
- Prefer `@returns` to `@return` - Prefer `@param` to `@arg` - Prefer capitalised types See: https://github.com/resin-io/etcher/pull/1111#discussion_r103483879 Signed-off-by: Juan Cruz Viotti <jviotti@openmailbox.org>
This commit is contained in:
parent
33a4ed8c95
commit
4172291a10
@ -71,6 +71,17 @@ rules:
|
|||||||
- error
|
- error
|
||||||
- requireReturn: false
|
- requireReturn: false
|
||||||
requireReturnDescription: false
|
requireReturnDescription: false
|
||||||
|
requireReturnType: true
|
||||||
|
requireParamDescription: true
|
||||||
|
preferType:
|
||||||
|
boolean: "Boolean"
|
||||||
|
number: "Number"
|
||||||
|
object: "Object"
|
||||||
|
string: "String"
|
||||||
|
array: "Array"
|
||||||
|
prefer:
|
||||||
|
arg: "param"
|
||||||
|
return: "returns"
|
||||||
valid-typeof:
|
valid-typeof:
|
||||||
- error
|
- error
|
||||||
|
|
||||||
|
@ -105,7 +105,7 @@ SelectionStateModel.service('SelectionStateModel', function(DrivesModel) {
|
|||||||
* @function
|
* @function
|
||||||
* @public
|
* @public
|
||||||
*
|
*
|
||||||
* @returns {object}
|
* @returns {Object} image
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* const image = SelectionStateModel.getImage();
|
* const image = SelectionStateModel.getImage();
|
||||||
|
Loading…
x
Reference in New Issue
Block a user