chore: Add comment to test build

juspay · Oct 25, 2024 · a16af59 · a16af59
1 parent 705c881
commit a16af59
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/crates/omnix-hack/src/core.rs b/crates/omnix-hack/src/core.rs
@@ -7,9 +7,13 @@ use omnix_health::{check::caches::CachixCache, traits::Checkable, NixHealth};
 
 use crate::config::HackConfig;
 
+/// A project that an be hacked on locally.
 pub struct Project {
+    /// The directory of the project.
     pub dir: PathBuf,
+    /// [FlakeUrl] corresponding to the project.
     pub flake: FlakeUrl,
+    /// The hack configuration
     pub cfg: HackConfig,
 }