From 1498ea4290155be7a38f3e96d5b4c6e85367cdb0 Mon Sep 17 00:00:00 2001 From: argus Date: Wed, 18 Nov 2026 20:09:39 +0100 Subject: [PATCH] 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. --- .hyperhive/review-classifier.yml | 12 ++++++++++++ swarm-controller/src/review_classifier.rs | 1 + 2 files changed, 13 insertions(+) diff --git a/.hyperhive/review-classifier.yml b/.hyperhive/review-classifier.yml index df801cadd..cd9b66b9d 100644 --- a/.hyperhive/review-classifier.yml +++ b/.hyperhive/review-classifier.yml @@ -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 diff --git a/swarm-controller/src/review_classifier.rs b/swarm-controller/src/review_classifier.rs index d990e14c8..1f55f9c61 100644 --- a/swarm-controller/src/review_classifier.rs +++ b/swarm-controller/src/review_classifier.rs @@ -1420,6 +1420,7 @@ classifications: "message-claims-match-diff", "no-code-units-in-operator-docs", "option-in-the-wrong-namespace", + "docs-describe-current-state", ] ); }