require-yields-description.md

require-yields-description

Requires a description for @yields tags.

Context	everywhere
Tags	yields
Recommended	false
Settings
Options

Failing examples

The following patterns are considered problems:

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

Passing examples

The following patterns are not considered problems:

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

/**
 * @yields
 *  The results.
 */
export function *test1(): IterableIterator<string> { yield "hello"; }