docs: document the main error type

jcornaz · Sep 15, 2022 · 31d7d1a · 31d7d1a
1 parent eb9108a
commit 31d7d1a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/src/error.rs b/src/error.rs
@@ -1,3 +1,9 @@
+/// Main error type
+///
+/// It doesn't provide any useful information yet.
+///
+/// It will probably be improved in the futur to make possible
+/// user-friendly error messages.
 #[derive(Debug, Clone)]
 #[non_exhaustive]
 pub struct Error;

diff --git a/src/lib.rs b/src/lib.rs
@@ -34,7 +34,6 @@ mod amount;
 mod date;
 #[allow(missing_docs)]
 mod directive;
-#[allow(missing_docs)]
 mod error;
 #[allow(missing_docs)]
 mod string;