1995811 - Enable ESLint rule jsdoc/multiline-blocks

Status: RESOLVED FIXED

(Developer Infrastructure :: Lint and Formatting, task, P3)

Description

[Mark Banner (:standard8)]

The jsdoc/multiline-blocks rule can control if jsdoc comments are expressed as multi-line or single line. However, in the default mode it allows both, but has additional checks for ensuring that comments are not on the start or end lines of a block (noZeroLineText / noFinalLineText).

I'm proposing that we enable this, so that we have more consistency in our jsdoc comments. I think this also catches (or at least helps) some instances of jsdoc where it is hard for the jsdoc/no-multi-asterisks to auto-fix correctly.

Comment 1

[Mark Banner (:standard8)]

Attachment: Bug 1995811 - Enable ESLint rule jsdoc/multiline-blocks. r?#frontend-codestyle-reviewers!

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/32783c46e8ab
https://hg.mozilla.org/integration/autoland/rev/475bcfbc84da
Enable ESLint rule jsdoc/multiline-blocks. r=frontend-codestyle-reviewers,perftest-reviewers,sparky,nchevobbe,whimboo,Gijs

Comment 3

[Norisz Fay [:noriszfay]]

https://hg.mozilla.org/mozilla-central/rev/475bcfbc84da