Add comment

mitghi · Mar 11, 2023 · 2460060 · 2460060
1 parent b45da47
commit 2460060
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/parser.rs b/src/parser.rs
@@ -14,6 +14,9 @@ use crate::*;
 #[grammar = "./grammar.pest"]
 pub struct ExpressionParser;
 
+/// parse parses the jetro expression, builds the filter along with
+/// abstract syntax tree. It returns an error containing details about
+/// cause of parser failure.
 pub(crate) fn parse<'a>(input: &'a str) -> Result<Vec<Filter>, pest::error::Error<Rule>> {
     let pairs = ExpressionParser::parse(Rule::expression, input);
     if pairs.is_err() {