TRF008

add_start_docstrings on a model class should not be empty.

Default	Enabled
Scope	All models
Source	mlinter/trf008.py
Show in terminal	mlinter --rule TRF008

What it does

Checks that add_start_docstrings on a model class gets a non-empty argument.

Why is this bad?

An empty argument produces unclear, low-quality generated API docs.

Example

-@add_start_docstrings("")
+@add_start_docstrings("The Acme model.")
 class AcmeModel(AcmePreTrainedModel):
     ...

Suppressing this rule

Add a # trf-ignore: TRF008 comment on the flagged line or the line directly above it. See Suppressing rules for whole-file directives and when a suppression is the wrong answer.