require-throws-description

September 18, 2025 ยท View on GitHub

require-throws-description

Requires a description for @throws tags.

Contexteverywhere
Tagsthrows
Recommendedfalse
Settings
Options

Failing examples

The following patterns are considered problems:

/**
 * @throws {SomeType}
 */
// Message: @throws should have a description

Passing examples

The following patterns are not considered problems:

/**
 * @throws {SomeType} Has a description
 */