# python/pydoclint

> Checks that each docstring names the arguments, return value, and exceptions of its function.

Checks that each docstring names the arguments, return value, and exceptions of its function.

Part of the [`python`](/reference/configurations/python/) configuration, at the `recommended` [level](/start/concepts/#levels). It runs at the `commit` [stage](/start/concepts/#stage), per file. It runs pydoclint.

## Why

A docstring that contradicts the signature misleads more than none, because people trust it.

## What to do

Bring the docstring in line with the signature.

## Example

A docstring that documents `name` for a function that takes `path` reports a mismatch. Document `path` instead.

## Turn it off

Turn it off for some files, with a reason:

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