be explicit about assumptions on Project methods

tbillington · Apr 26, 2024 · ab1558e · ab1558e
1 parent 95f7077
commit ab1558e
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/kondo-lib/src/project.rs b/kondo-lib/src/project.rs
@@ -16,7 +16,9 @@ pub trait Project {
     fn kind_name(&self) -> &'static str;
     fn name(&self, root_dir: &Path) -> Option<String>;
     fn is_project(&self, root_dir: &Path) -> bool;
+    /// Assumes `root_path` is a valid `Project` of the same kind resulting from `Project::is_proejct`
     fn is_root_artifact(&self, root_path: &Path) -> bool;
+    /// Assumes `root_dir` is a valid `Project` of the same kind resulting from `Project::is_proejct`
     fn root_artifacts(&self, root_dir: &Path) -> Vec<PathBuf>;
 }