add doc for cradleErrorLoadingFiles

haskell · Feb 26, 2025 · 3351cfc · 3351cfc
1 parent 8cdacbe
commit 3351cfc
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/HIE/Bios/Types.hs b/src/HIE/Bios/Types.hs
@@ -273,6 +273,9 @@ data CradleError = CradleError
   -- ^ Standard error output that can be shown to users to explain
   -- the loading error.
   , cradleErrorLoadingFiles :: [FilePath]
+  -- ^ files that were attempted to be loaded by the cradle.
+  -- This can be useful if we are loading multiple files at once,
+  -- e.g. in a cabal cradle with the multi-repl feature.
   }
   deriving (Show, Eq)