From 77e22e9a014c36f56e7862e1a190ea351425b354 Mon Sep 17 00:00:00 2001 From: Martin Duhem Date: Wed, 11 Oct 2023 21:18:22 +0200 Subject: [PATCH] Small documentation fixes --- main/src/main/scala/sbt/ExecuteProgress2.scala | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/main/src/main/scala/sbt/ExecuteProgress2.scala b/main/src/main/scala/sbt/ExecuteProgress2.scala index 41ed6e658..006b8f829 100644 --- a/main/src/main/scala/sbt/ExecuteProgress2.scala +++ b/main/src/main/scala/sbt/ExecuteProgress2.scala @@ -13,6 +13,10 @@ import sbt.internal.util.RMap * Tracks command execution progress. In addition to ExecuteProgress, this interface * adds command start and end events, and gives access to the sbt.State at the beginning * and end of each command. + * + * Command progress callbacks are wrapping task progress callbacks. That is, the `beforeCommand` + * callback will be called before the `initial` callback from ExecuteProgress, and the + * `afterCommand` callback will be called after the `stop` callback from ExecuteProgress. */ trait ExecuteProgress2 extends ExecuteProgress[Task] { @@ -30,7 +34,9 @@ trait ExecuteProgress2 extends ExecuteProgress[Task] { * @param cmd The command string. * @param result Left in case of an error. If the command cannot be parsed, it will be * signalled as a ParseException with a detailed message. If the command - * was cancelled by the user, as sbt.Cancelled. + * was cancelled by the user, as sbt.Cancelled. If the command succeeded, + * Right with the new state after command execution. + * */ def afterCommand(cmd: String, result: Either[Throwable, State]): Unit }