Update doc

fredyw · Sep 3, 2024 · 88caaf1 · 88caaf1
1 parent a6cb5c3
commit 88caaf1
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/bulk_rename.rs b/src/bulk_rename.rs
@@ -11,9 +11,12 @@ pub struct BulkRename<'a> {
     replacement: &'a str,
 }
 
+/// Possible errors when running a bulk rename.
 #[derive(Debug)]
 pub enum Error {
+    /// An error for when the path is not a directory.
     NotDirError,
+    /// An error for when the regex is invalid.
     RegexError(regex::Error),
 }