8924: Add last remaining module docstring r=flodiebold a=flodiebold

That was easier than expected.

Co-authored-by: Florian Diebold <flodiebold@gmail.com>
This commit is contained in:
bors[bot] 2021-05-22 14:41:21 +00:00 committed by GitHub
commit 5b6fa95699
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 22 deletions

View File

@ -1,4 +1,6 @@
//! FIXME: write short doc here
//! Various diagnostics for expressions that are collected together in one pass
//! through the body using inference results: mismatched arg counts, missing
//! fields, etc.
use std::sync::Arc;

View File

@ -1,7 +1,4 @@
use std::{
collections::HashMap,
path::{Path, PathBuf},
};
use std::path::{Path, PathBuf};
use xshell::{cmd, pushd, pushenv, read_file};
@ -392,25 +389,9 @@ impl TidyDocs {
)
}
let poorly_documented = ["hir_ty"];
let mut has_fixmes =
poorly_documented.iter().map(|it| (*it, false)).collect::<HashMap<&str, bool>>();
'outer: for path in self.contains_fixme {
for krate in poorly_documented.iter() {
if path.components().any(|it| it.as_os_str() == *krate) {
has_fixmes.insert(krate, true);
continue 'outer;
}
}
for path in self.contains_fixme {
panic!("FIXME doc in a fully-documented crate: {}", path.display())
}
for (krate, has_fixme) in has_fixmes.iter() {
if !has_fixme {
panic!("crate {} is fully documented :tada:, remove it from the list of poorly documented crates", krate)
}
}
}
}