Skip to content

fix (docs): grammar clean-up in comments #8988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
orizi merged 2 commits into from
Dec 10, 2025
Merged

fix (docs): grammar clean-up in comments #8988

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
16a4800
fix (docs): minor grammar issues in comments
mdqst Dec 9, 2025
529145f
Update compile.rs
mdqst Dec 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions crates/cairo-lang-starknet/src/compile.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ use crate::starknet_plugin_suite;
#[path = "compile_test.rs"]
mod test;

/// Compile the contract given by path.
/// Compile the contract given by the path.
/// Errors if there is ambiguity.
pub fn compile_path(
path: &Path,
Expand All @@ -60,7 +60,7 @@ pub fn compile_path(

/// Runs Starknet contract compiler on the specified contract.
/// If no contract was specified, verify that there is only one.
/// Otherwise, return an error.
/// Otherwise, returns an error.
pub fn compile_contract_in_prepared_db<'db>(
db: &'db dyn Database,
contract_path: Option<&str>,
Expand Down Expand Up @@ -99,7 +99,7 @@ pub fn compile_contract_in_prepared_db<'db>(
Ok(compile_prepared_db(db, &[contract], compiler_config)?.into_iter().exactly_one()?)
}

/// Runs Starknet contracts compiler.
/// Runs Starknet contract compiler.
///
/// # Arguments
/// * `db` - Preloaded compilation database.
Expand All @@ -121,11 +121,11 @@ pub fn compile_prepared_db<'db>(
})
}

/// Compile declared Starknet contract.
/// Compile the declared Starknet contract.
///
/// The `contract` value **must** come from `db`, for example as a result of calling
/// [`find_contracts`]. Does not check diagnostics, it is expected that they are checked by caller
/// of this function.
/// [`find_contracts`]. Does not check diagnostics, it is expected that they are checked
/// by the caller of this function.
fn compile_contract_with_prepared_and_checked_db<'db>(
db: &'db dyn Database,
contract: &ContractDeclaration<'db>,
Expand Down Expand Up @@ -230,7 +230,7 @@ fn get_entry_points<'db>(
Ok(entry_points)
}

/// Compile Starknet crate (or specific contract in the crate).
/// Compile a Starknet crate (or specific contract in the crate).
pub fn starknet_compile(
crate_path: PathBuf,
contract_path: Option<String>,
Expand Down