Skip to main content

check_group_module_docs

Function check_group_module_docs 

Source
pub fn check_group_module_docs(
    parsed: &[ParsedFile],
    groups: &BTreeMap<String, Vec<usize>>,
) -> Result<(), Vec<(PathBuf, CompileError)>>
Expand description

#1885 (DECISION D): a unit split across files carries at most one module doc — the doc-block above its header. Two or more would have to be joined in some file order, which readers would not expect, so each file that carries one gets bynk.project.duplicate_module_doc, naming every such file (paths /-joined on every platform).

groups holds production units only (suite files are grouped separately), so a suite’s doc is never counted. The rule is kind-agnostic: a commons may be multi-file too, and the same ambiguity applies to it.