Skip to content

Commit

Permalink
chore: improve some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bitwalker committed Aug 4, 2024
1 parent c1a47ea commit 01b7922
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
8 changes: 4 additions & 4 deletions assembly/src/library/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -547,11 +547,11 @@ mod use_std_kernel {
) -> io::Result<()> {
self.library.write_to_file(path, options)
}
/// Read a directory and recursively create modules from its `masm` files.
///
/// For every directory, concatenate the module path with the dir name and proceed.

/// Create a [KernelLibrary] from a standard Miden Assembly project layout.
///
/// For every file, pick and compile the ones with `masm` extension; skip otherwise.
/// This is essentially a wrapper around [CompiledLibrary::from_dir], which then validates
/// that the resulting [CompiledLibrary] is a valid [KernelLibrary].
pub fn from_dir(
path: impl AsRef<Path>,
source_manager: Arc<dyn SourceManager>,
Expand Down
1 change: 1 addition & 0 deletions assembly/src/parser/lexer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ macro_rules! pop2 {
/// guarantee that parsing them will produce meaningful results, it is primarily to assist in
/// gathering as many errors as possible.
pub struct Lexer<'input> {
/// The [SourceId] of the file being lexed, for use in producing spans in lexer diagnostics
source_id: SourceId,

/// The scanner produces a sequence of chars + location, and can be controlled
Expand Down

0 comments on commit 01b7922

Please sign in to comment.