# Docs that restate the name (`"""Get the user."""`, `name: The name.`, `@returns The result.`)

*Comments and text*: one of the ways AI coding agents bloat software, from lessloc's [pattern catalog](https://lessloc.org/patterns/index.md). lessloc catches it as [`narration`](https://lessloc.org/guide/reference.md#tier-3).

## What makes docs that restate the name a bad practice?

The standards that call it a bad practice: Clean Code: Mandated Comments; Google Python Style Guide (no types in docstrings where annotations exist).

## What does lessloc do about docs that restate the name?

lessloc catches it as [`narration`](https://lessloc.org/guide/reference.md#tier-3).

- `narration` (tier 3): Comments that narrate the code, decorate it or restate a name, closing-brace comments, and log lines that narrate each step.

## Examples

Caught as `narration`:

```python [n.py]
def ship(order, carrier):
    """Ship an order.

    Args:
        order: The order.
        carrier: The carrier.
    """
    return order
```

Written well:

```python [n.py]
def ship(order, carrier):
    """Hand the order to the carrier; raises if the address is unverified.

    Args:
        carrier: one of "ups", "dhl"; anything else ships by post.
    """
    return order
```

## Related patterns

The other patterns in [Comments and text](https://lessloc.org/patterns/index.md#comments-and-text):

- [Comments that narrate what the code does](https://lessloc.org/patterns/narration.md): lessloc catches it as `narration`.
- [Banners, dividers, closing-brace comments, emoji decoration](https://lessloc.org/patterns/decoration.md): lessloc catches it as `narration`.
- [History and messages to the requester](https://lessloc.org/patterns/history.md): lessloc catches it as `history`.
- [Comment blocks and comment-heavy changes](https://lessloc.org/patterns/comment-weight.md): lessloc catches it as `comment-block` and `comment-density`.
- [Log lines that narrate each step](https://lessloc.org/patterns/log-chatter.md): lessloc catches it as `narration` (three or more in a file).
- [Docs that still name what a change removed](https://lessloc.org/patterns/stale-doc.md): lessloc catches it as `stale-doc`.
- [Summary, report and notes files](https://lessloc.org/patterns/index.md#report-files): lessloc catches it as `junk-file` and refuses it before it lands.
- [Doc files and README growth nobody asked for](https://lessloc.org/patterns/unrequested-docs.md): lessloc catches it as `unrequested-doc`.
- [Docs deleted wholesale to shrink a change](https://lessloc.org/patterns/doc-removed.md): lessloc catches it as `doc-removed`.
- [Always-loaded instructions that grow](https://lessloc.org/patterns/long-instructions.md): lessloc catches it as `long-instructions`.
- [Commit messages that recap the diff file by file](https://lessloc.org/patterns/commit-recaps.md): The commit hook warns when a message lists the files the diff shows.