Skip to content

fix: correct comment for Git::has_submodules and remove_contract #12530

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
merged 5 commits into from
Nov 20, 2025
Merged

fix: correct comment for Git::has_submodules and remove_contract #12530

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
019890c
fix(cli): clarify remove_contract docs
sashass1315 Nov 11, 2025
44bd574
Fix doc comment for Git::has_submodules to match behavior
sashass1315 Nov 11, 2025
8695aad
rename function
sashass1315 Nov 13, 2025
6b37b9f
rename
sashass1315 Nov 13, 2025
28a8568
cargo fmt
sashass1315 Nov 13, 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
4 changes: 2 additions & 2 deletions crates/cli/src/utils/cmd.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ use std::{
};
use yansi::Paint;

/// Given a `Project`'s output, removes the matching ABI, Bytecode and
/// Runtime Bytecode of the given contract.
/// Given a `Project`'s output, finds the contract by path and name and returns its
/// ABI, creation bytecode, and `ArtifactId`.
#[track_caller]
pub fn remove_contract(
Copy link
Contributor

@onbjerg onbjerg Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please also rename the function.

Copy link
Contributor Author

@sashass1315 sashass1315 Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please also rename the function.

Did it ser, thank you for your review

output: ProjectCompileOutput,
Expand Down
2 changes: 1 addition & 1 deletion crates/cli/src/utils/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -630,7 +630,7 @@ ignore them in the `.gitignore` file."
.map(|stdout| stdout.lines().any(|line| line.starts_with('-')))
}

/// Returns true if the given path has no submodules by checking `git submodule status`
/// Returns true if the given path has submodules by checking `git submodule status`
pub fn has_submodules<I, S>(self, paths: I) -> Result<bool>
where
I: IntoIterator<Item = S>,
Expand Down
Loading