# python/placeholder-docstrings

> Finds docstrings that hold a placeholder word, or the name of the function again.

Finds docstrings that hold a placeholder word, or the name of the function again.

Part of the [`python`](/reference/configurations/python/) configuration, at the `all` [level](/start/concepts/#levels). It runs at the `commit` [stage](/start/concepts/#stage), once per scope. gspot runs this check itself.

## Why

A docstring that says nothing satisfies the lint rule and wastes the line.

## What to do

Say what the function does that its name does not, or for whom it exists.

## Example

A docstring that only repeats the function name reports a placeholder. Describe the behavior, inputs, and effects that the name leaves out.

## Turn it off

Turn it off for some files, with a reason:

```shell
gspot ignore python/placeholder-docstrings --paths "<glob>" --reason "<why>"
```