Closed willeastcott closed 1 year ago
The hyphen sometimes is used to delimit alignment, but the new fix will only do so if the hyphen has at least some whitespace after it.
:tada: This issue has been resolved in version 44.2.5 :tada:
The release is available on:
Your semantic-release bot :package::rocket:
It seems that the
jsdoc/check-line-alignment
rule is triggered if an@returns
description begins with-1
(number).Expected behavior
AFAIK, the dash is not recommended to delimit the @returns type from the description. So I would expect this to not trigger the error.
Actual behavior
Error is output:
ESLint Config
Include this:
This appears in this full config:
https://github.com/playcanvas/playcanvas-eslint-config/blob/9dac541d64a73876ed27d5298eed7197981e6958/index.js#L400
ESLint sample
This code triggers the error:
Error output is:
Doing an autofix will update this:
To this:
This completely changes the meaning of the docs, of course.
Environment
eslint-plugin-jsdoc
version: v44.2.4