diff --git a/main/State.scala b/main/State.scala index 05cea6202..6d81f07ac 100644 --- a/main/State.scala +++ b/main/State.scala @@ -64,7 +64,9 @@ trait StateOps { @deprecated("Use setNext", "0.11.0") def setResult(ro: Option[xsbti.MainResult]): State - /** Restarts sbt without dropping loaded Scala classes. It is a shallower restart than `reboot`.*/ + /** Restarts sbt without dropping loaded Scala classes. It is a shallower restart than `reboot`. + * This method takes a snapshot of the remaining commands and will resume executing those commands after reload. + * This means that any commands added to this State will be dropped.*/ def reload: State /** Sets the next command processing action to be to rotate the global log and continue executing commands.*/