TRF008
Doc decorators on PreTrainedModel classes should avoid empty add_start_docstrings usage.
| Default | Enabled |
| Scope | All models |
| Source | mlinter/trf008.py |
| Show in terminal | mlinter --rule TRF008 |
What it does
Checks add_start_docstrings usage on model classes for non-empty docstring arguments.
Why is this bad?
Empty decorator usage produces unclear docs and weakens generated API documentation quality.
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.
