---
url: https://scruple.dev/rules/comments/require-actionable-deprecations.md
description: Require migration guidance in deprecations.
---

# comments/require-actionable-deprecations

Require migration guidance in deprecations.

## What it checks

Deprecated APIs should name a replacement, give concrete migration steps, or explain usefully why no replacement exists.

## Rule metadata

* Package: `@scruple/comments`
* Category: API documentation
* Tags: deprecation, migration, documentation
* Default threshold: `0.85`
* Minimum confidence: `0.7`

## Examples

### Reported

```ts
/** @deprecated */
export function loadOld() {}
```

### Accepted

```ts
/** @deprecated Use load() instead. */
export function loadOld() {}
```