From c8bcb9fce7f672f477186d9d498734c6ff676a4b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jo=C3=A3o=20Magalh=C3=A3es?= <joamag@gmail.com>
Date: Sat, 23 Mar 2024 10:02:09 +0000
Subject: [PATCH] chore: tiny docstring changes
Allows better understanding of the message.
---
src/error.rs | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/src/error.rs b/src/error.rs
index 8ca51a4c..2465f6d9 100644
--- a/src/error.rs
+++ b/src/error.rs
@@ -1,6 +1,7 @@
use std::fmt::{self, Display, Formatter};
-/// Top level enum for error handling.
+/// Top level enum for error handling within Boytacean.
+///
/// Most of the time, you will want to use the `CustomError` variant
/// to provide a more detailed error message.
#[derive(Debug, Clone, PartialEq, Eq)]
--
GitLab