20eb3325

By: Tom Sydney Kerckhove <syd@cs-syd.eu>

Let a rule cite no guide

HsNoFilePath cited haskell-style.md's "Preferred libraries", which does not say
anything about paths. The rule was decided in review, and the guides have not
caught up. Pointing it at some other section to make the citation resolve would
have been worse than pointing it nowhere: a reader following it would land on a
section that does not say what they were sent to read.

So ruleGuide is a Maybe, and HsNoFilePath has none. What that changes for a
reader:

explain says "Decided in review. The guides do not carry this one yet." where it
otherwise says which guide and which section.

A finding puts what the rule asks for under the span, where a guided rule puts
the guide's own words, and drops the note that would otherwise say where the
rule comes from. The reason and the suppression hint are unchanged. Without
that, the note and the label would have said the same sentence twice.

list-rules leaves the guide column empty, which is what the README's table says
with "none yet" and what scripts/check-readme.sh reads it as.

The other five rules keep their guides, and a rule with one is unchanged in
every output.

Timeline