Unnamed repository; edit this file 'description' to name the repository.
Diffstat (limited to 'lib/ungrammar/src/error.rs')
-rw-r--r--lib/ungrammar/src/error.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/lib/ungrammar/src/error.rs b/lib/ungrammar/src/error.rs
index a7a62d0cc0..6cc86f52f9 100644
--- a/lib/ungrammar/src/error.rs
+++ b/lib/ungrammar/src/error.rs
@@ -3,8 +3,10 @@ use std::fmt;
use crate::lexer::Location;
+/// A type alias for std's Result with the Error as our error type.
pub type Result<T, E = Error> = std::result::Result<T, E>;
+/// An error encountered when parsing a Grammar.
#[derive(Debug)]
pub struct Error {
pub(crate) message: String,