review classifier: docs describe the current state, not what was removed
A new negative rule: text added under docs/, in a README or a doc comment
that documents something that no longer exists ("nothing reads this file
now", "older versions wrote X"). Migration pages, changelogs and
removed-option messages are exempt. The rules-file test lists the new name.
This commit is contained in:
parent
188dbcea8b
commit
1498ea4290
1 changed files with 13 additions and 0 deletions
|
|
@ -132,3 +132,15 @@ classifications:
|
|||
applicable.
|
||||
polarity: negative
|
||||
threshold: 70
|
||||
- name: docs-describe-current-state
|
||||
description: >-
|
||||
Text the diff adds or changes under docs/, in a README or in a doc
|
||||
comment documents something that no longer exists, instead of the
|
||||
current state: "nothing reads this file now", "older versions wrote
|
||||
X", "this used to be Y", "the old Z is gone". Docs say what is, not
|
||||
what was. A migration or upgrade page, a changelog and a removed-option
|
||||
message may name the removed thing, because naming it is their job. A
|
||||
diff that adds or changes no documentation makes the question not
|
||||
applicable.
|
||||
polarity: negative
|
||||
threshold: 70
|
||||
|
|
|
|||
Loading…
Reference in a new issue