Skip to content

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

Closed
@pyoor

Description

@pyoor

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions