From af6e2b55cc276d5a5ba8849af8a66c4535becc46 Mon Sep 17 00:00:00 2001
From: Karol Lewandowski <karol.lewandowski@jetbrains.com>
Date: Wed, 12 Feb 2025 16:54:45 +0100
Subject: [PATCH] background_processes.md: Clarify ProgressIndicator vs
 ProgressManager

---
 .../architectural_overview/background_processes.md  | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/topics/basics/architectural_overview/background_processes.md b/topics/basics/architectural_overview/background_processes.md
index 2a141b0cf..37b28b9b5 100644
--- a/topics/basics/architectural_overview/background_processes.md
+++ b/topics/basics/architectural_overview/background_processes.md
@@ -165,17 +165,22 @@ Use inspection <control>Plugin DevKit | Code | Cancellation check in loops</cont
 
 ### Tracking Progress
 
-Displaying progress to the user is achieved with `ProgressIndicator` or `ProgressManager` if no indicator instance is available in the current context.
+Displaying progress to the user is achieved with:
+- `ProgressIndicator` - if available in the current context
+- `ProgressManager` - if no indicator instance is available in the current context
 
-To report progress, use the following methods:
-- `setText(String)` – sets text above the progress bar
-- `setText2(String)` – sets text under the progress bar
+To report progress with `ProgressIndicator`, use the following methods:
+- `setText(String)` – sets the progress text displayed above the progress bar
+- `setText2(String)` – sets the progress details text displayed under the progress bar
 - `setFraction(double)` – sets the progress fraction: a number between 0.0 (nothing) and 1.0 (all) reflecting the ratio of work that has already been done.
   Only works for determinate indicator.
   The fraction should provide the user with an estimation of the time left.
   If this is impossible, consider making the progress indeterminate.
 - `setIndeterminate(boolean)` – marks the progress indeterminate (for processes that can't estimate the amount of work to be done) or determinate (for processes that can display the fraction of the work done using `setFraction(double)`).
 
+`ProgressManager` allows for reporting progress texts through `progress()`/`progress2()` methods, which are counterparts of `ProgressIndicator.setText()`/`setText2()`.
+In addition, it exposes the `ProgressIndicator.getProgressIndicator()` method for getting an indicator instance associated with the current thread.
+
 ## `ProcessCanceledException` and Debugging
 
 Sometimes, a PCE is thrown from `checkCanceled()` in the code inspected by a plugin developer during a debugging session.