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

Manage heading with require-description-complete-sentence #1220

Open
PierBJX opened this issue Mar 29, 2024 · 0 comments
Open

Manage heading with require-description-complete-sentence #1220

PierBJX opened this issue Mar 29, 2024 · 0 comments

Comments

@PierBJX
Copy link

PierBJX commented Mar 29, 2024

Expected behavior

I expect to not need to add a dot at the end of a heading in a JS description.

Actual behavior

In our coding rules, it is needed to add a description with some headings (only for class). However, there is a heading which does not contain any sentence but only code sample. Hence, it raises an error because after the heading # Example it expects a dot.

ESLint Config

    "jsdoc/require-description-complete-sentence": [
      "error",
      {
        "abbreviations": [
          "etc",
          "e.g.",
          "i.e."
        ]
      }
    ],

ESLint sample

/**
 * ### Overview
 * My class is doing.
 *
 * ### Example
 * ```javascript
 *  const toto = 'toto';
 * ```
 */
export class ClassExemple {
}

Environment

  • Node version: v18.18.2
  • ESLint version v8.56.0
  • eslint-plugin-jsdoc version: 46.10.1
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

1 participant