---
url: /docs/guide/usage/linter/rules/jsdoc/require-yields-description.md
---

### What it does

Requires a description for `@yields` tags.

### Why is this bad?

A `@yields` tag should explain what the generator yields.

### Examples

Examples of **incorrect** code for this rule:

```js
/**
 * @yields {string}
 */
function* quux() {
  yield "value";
}
```

Examples of **correct** code for this rule:

```js
/**
 * @yields {string} The next value.
 */
function* quux() {
  yield "value";
}
```

## How to use

## Version

This rule was added in v1.68.0.

## References