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

[jsdoc/require-description-complete-sentence] Error on @link type #705

Closed
pyoor opened this issue Mar 16, 2021 · 2 comments
Closed

[jsdoc/require-description-complete-sentence] Error on @link type #705

pyoor opened this issue Mar 16, 2021 · 2 comments
Labels

Comments

@pyoor
Copy link

pyoor commented Mar 16, 2021

Expected behavior

The plugin jsdoc/require-description-complete-sentence would not raise when including a @link types.

Actual behavior

An error is raised.

ESLint Config

module.exports = {
  env: {
    es2020: true,
    node: true,
  },
  root: true,
  parser: '@typescript-eslint/parser',
  plugins: ['@typescript-eslint', 'jsdoc'],
  rules: {
    'jsdoc/require-description-complete-sentence': ['warn'],
  },
}

ESLint sample

/**
 * Say Hello.
 *
 * {@link http://www.github.com} // ESLint: Sentence must end with a period.(jsdoc/require-description-complete-sentence)
 */
function hello(): void {
    console.log("hello world")
}

Environment

  • Node version: v14.16.0
  • ESLint version v7.22.0
  • eslint-plugin-jsdoc version: v32.3.0
@brettz9
Copy link
Collaborator

brettz9 commented Mar 25, 2021

One problem here is that @link is inline, so a person may actually want a period after it.

@brettz9
Copy link
Collaborator

brettz9 commented Mar 29, 2022

Closing as I think insisting on a sentence would call for a period after the inline link too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants