Skip to content

Commit

Permalink
improve doc for parse_and_run_program
Browse files Browse the repository at this point in the history
  • Loading branch information
yihozhang committed Aug 15, 2024
1 parent 994d8c3 commit 8df581d
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1525,8 +1525,12 @@ impl EGraph {
self.desugar.parse_program(filename, input)
}

/// Parse and run a program, returning a list of messages.
/// If filename is None, a default name will be provided

/// Takes a source program `input`, parses it, runs it, and returns a list of messages.
///
/// `filename` is an optional argument to indicate the source of
/// the program for error reporting. If `filename` is `None`,
/// a default name will be used.
pub fn parse_and_run_program(
&mut self,
filename: Option<String>,
Expand Down

0 comments on commit 8df581d

Please sign in to comment.