Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Regression] newline-after-description false-positive for description starting on first line of comment #668

Closed
kevinoid opened this issue Jan 11, 2021 · 2 comments

Comments

@kevinoid
Copy link

Expected behavior

jsdoc/newline-after-description would not warn about descriptions which start on the first comment line (i.e. the line with /**) and have a newline after the description, as it behaved in 30.7.13 and before.

Actual behavior

index.js
  2:0  error  There must be a newline after the description of the JSDoc block  jsdoc/newline-after-description

✖ 1 problem (1 error, 0 warnings)
  1 error and 0 warnings potentially fixable with the `--fix` option.

ESLint Config

{
  "plugins": [
    "jsdoc"
  ],
  "rules": {
    "jsdoc/newline-after-description": "error"
  }
}

ESLint sample

/** An example function.
 *
 * @returns {number} An example number.
 */
function example() {
  return 42;
}

Environment

  • Node version: v12.19.0
  • ESLint version: v7.17.0
  • eslint-plugin-jsdoc version: 31.0.2

Thanks,
Kevin

@kevinoid
Copy link
Author

Lightning-fast as always. Thanks again @brettz9!

@gajus
Copy link
Owner

gajus commented Jan 11, 2021

🎉 This issue has been resolved in version 31.0.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gajus gajus added the released label Jan 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants