~/bend-docscommunity

src/rules/style/doc.bend fails

raw source on the hub · import 0xde9bb08f7de298b03207fb5797ede9a5/src/rules/style/doc.bend as Doc

rule doc: every top-level def, type and law has a comment block right above it: one or more column-0 # lines with no blank line between them and the item. A block of bare # lines counts, though its text is empty; a line that starts inside a multi-line string literal is text, never a comment line. Helpers (dotted names like show.go) ride on their parent's doc, main needs none, PROOF.bend fills laws that LAWS.bend already documents, and a test (under tests/) is documented by its header and its check names.

7 imports
import Base
import ../../src.bend as Src
import ../../finding.bend as F
import ../../syntax/outline.bend as Outline
import ../../lazy/lazy.bend as Lazy
import ../../paths.bend as Paths
import ../../syntax/lex.bend as Lex