Skip to main content

MIN_PROSE_WORDS

Constant MIN_PROSE_WORDS 

Source
pub const MIN_PROSE_WORDS: usize = 6;
Expand description

The fewest words of prose the documentation of a behaviour-bearing exported item must carry, below which it is repeating the signature.

Six is not a measurement of quality; it is the point below which a doc comment is demonstrably Gets the config. and nothing else. The lint the compiler already runs catches the absence of documentation; this catches its ceremonial form.

It applies to what crate::quality::ItemKind::carries_behaviour is true of, and not to a field, a variant or a constant: those are named and typed, a four-word gloss of one is often complete, and a longer bar would buy padding rather than meaning.