Skip to content

Commit

Permalink
chore: comments
Browse files Browse the repository at this point in the history
  • Loading branch information
nhtyy committed Nov 25, 2024
1 parent 361428f commit 7a49613
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions crates/build/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,8 @@ impl Default for BuildArgs {
///
/// # Arguments
///
/// * `path` - A string slice that holds the path to the program directory.
/// * `path` - A path to the guest program directory, if not absolute, assumed to be relative to
/// the caller manifest directory.
///
/// This function is useful for automatically rebuilding the program during development
/// when changes are made to the source code or its dependencies.
Expand All @@ -121,7 +122,9 @@ pub fn build_program(path: impl AsRef<Path>) {
///
/// # Arguments
///
/// * `path` - A string slice that holds the path to the program directory.
/// * `path` - A path to the guest program directory, if not absolute, assumed to be relative to
/// the caller manifest directory.
///
/// * `args` - A [`BuildArgs`] struct that contains various build configuration options.
///
/// Set the `SP1_SKIP_PROGRAM_BUILD` environment variable to `true` to skip building the program.
Expand Down

0 comments on commit 7a49613

Please sign in to comment.