From a88c7c04d28d6263d7bca69ee3014e42185030de Mon Sep 17 00:00:00 2001 From: Florian Diebold Date: Sat, 22 May 2021 16:39:19 +0200 Subject: Add last remaining module docstring --- crates/hir_ty/src/diagnostics/expr.rs | 4 +++- xtask/src/tidy.rs | 23 ++--------------------- 2 files changed, 5 insertions(+), 22 deletions(-) diff --git a/crates/hir_ty/src/diagnostics/expr.rs b/crates/hir_ty/src/diagnostics/expr.rs index b9a69b79c..53c4ee9da 100644 --- a/crates/hir_ty/src/diagnostics/expr.rs +++ b/crates/hir_ty/src/diagnostics/expr.rs @@ -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; diff --git a/xtask/src/tidy.rs b/xtask/src/tidy.rs index f97e751c5..82b33a7a0 100644 --- a/xtask/src/tidy.rs +++ b/xtask/src/tidy.rs @@ -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::>(); - '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) - } - } } } -- cgit v1.2.3