summaryrefslogtreecommitdiff
path: root/robusta_krr/utils/progress_bar.py
diff options
context:
space:
mode:
Diffstat (limited to 'robusta_krr/utils/progress_bar.py')
-rw-r--r--robusta_krr/utils/progress_bar.py7
1 files changed, 7 insertions, 0 deletions
diff --git a/robusta_krr/utils/progress_bar.py b/robusta_krr/utils/progress_bar.py
index 808a380..32bf211 100644
--- a/robusta_krr/utils/progress_bar.py
+++ b/robusta_krr/utils/progress_bar.py
@@ -5,6 +5,13 @@ from robusta_krr.utils.configurable import Configurable
class ProgressBar(Configurable):
+ """
+ Progress bar for displaying progress of gathering recommendations.
+
+ Use `ProgressBar` as a context manager to automatically handle the progress bar.
+ Use `progress` method to step the progress bar.
+ """
+
def __init__(self, config: Config, **kwargs) -> None:
super().__init__(config)
self.show_bar = self.echo_active