IJPL-274 document `ignoreProgressReportingIn`

(cherry picked from commit 498432ff0220e32de96a2642f8e806dbdb3cef71) IJ-CR-127983 GitOrigin-RevId: 5d5b704445d18cba13294b7f86e25891d75d4038

IJPL-274 document `ignoreProgressReportingIn`
(cherry picked from commit 498432ff0220e32de96a2642f8e806dbdb3cef71) IJ-CR-127983 GitOrigin-RevId: 5d5b704445d18cba13294b7f86e25891d75d4038
9cbf7e3f · Daniil Ovchinnikov · intellij-monorepo-bot · a9a22e45 · 9cbf7e3f
Commit 9cbf7e3f authored 1 year ago by Daniil Ovchinnikov Committed by intellij-monorepo-bot 1 year ago
Hide whitespace changes
Inline Side-by-side

Showing

with 3 additions and 0 deletions
+3 -0
--- a/platform/util/progress/src/steps.kt
+++ b/platform/util/progress/src/steps.kt
@@ -135,6 +135,9 @@ suspend fun <T> withProgressText(text: ProgressText?, action: ScopedLambda<T>):
  return currentProgressStep().withText(text, action)
 }

+/**
+ * Suppresses progress reporting inside [action] to avoid the [action] taking the ownership of the [current step][currentProgressStep].
+ */
 suspend fun <T> ignoreProgressReportingIn(action: suspend CoroutineScope.() -> T): T {
  // It's not possible to throw away a context element
  // => we replace the element with a null-object instead