---
url: https://scruple.dev/rules/comments/prefer-concise-comments.md
description: Prefer useful but concise comment prose.
---

# comments/prefer-concise-comments

Prefer useful but concise comment prose.

## What it checks

Long ordinary comments should be reduced when substantially shorter prose preserves their maintenance value.

## Rule metadata

* Package: `@scruple/comments`
* Category: Comment quality
* Tags: verbosity, readability, prose
* Default threshold: `0.9`
* Minimum confidence: `0.65`

## Examples

### Reported

```ts
// It is important to note that we intentionally retry only once here because another retry is performed by the queue worker upstream.
```

### Accepted

```ts
// The queue worker performs the second retry.
```
