Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Kobzol committed Jun 28, 2024
1 parent bee136f commit 0c599cb
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions src/bootstrap/src/utils/exec.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ pub enum OutputMode {
/// By default, the command will print its stdout/stderr to stdout/stderr of bootstrap
/// ([OutputMode::OnlyOutput]). If bootstrap uses verbose mode, then it will also print the
/// command itself in case of failure ([OutputMode::All]).
/// If you want to handle the output programmatically, use `output_mode(OutputMode::OnlyOnFailure)`.
/// If you want to handle the output programmatically, use `output_mode(OutputMode::OnlyOnFailure)`,
/// which will print the output only if the command fails.
///
/// [allow_failure]: BootstrapCommand::allow_failure
/// [delay_failure]: BootstrapCommand::delay_failure
Expand Down Expand Up @@ -113,7 +114,7 @@ impl BootstrapCommand {
}
}

/// This implementation is temporary, until all `Command` invocations are migrated to
/// FIXME: This implementation is temporary, until all `Command` invocations are migrated to
/// `BootstrapCommand`.
impl<'a> From<&'a mut Command> for BootstrapCommand {
fn from(command: &'a mut Command) -> Self {
Expand All @@ -138,7 +139,7 @@ impl<'a> From<&'a mut Command> for BootstrapCommand {
}
}

/// This implementation is temporary, until all `Command` invocations are migrated to
/// FIXME: This implementation is temporary, until all `Command` invocations are migrated to
/// `BootstrapCommand`.
impl<'a> From<&'a mut BootstrapCommand> for BootstrapCommand {
fn from(command: &'a mut BootstrapCommand) -> Self {
Expand Down

0 comments on commit 0c599cb

Please sign in to comment.