fix: progress-bar-docstring

probabl-ai · Jan 29, 2025 · 6c2c5f3 · 6c2c5f3
1 parent d297b58
commit 6c2c5f3
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/skore/src/skore/utils/_progress_bar.py b/skore/src/skore/utils/_progress_bar.py
@@ -11,6 +11,9 @@
 def progress_decorator(description):
     """Decorate class methods to add a progress bar.
 
+    This decorator adds a Rich progress bar to class methods, displaying progress
+    during execution. The progress bar automatically disappears after completion. 
+    
     Parameters
     ----------
     description : str or callable
@@ -43,7 +46,7 @@ def wrapper(*args, **kwargs):
                     ),
                     TextColumn("[orange1]{task.percentage:>3.0f}%"),
                     expand=False,
-                    transient=True
+                    transient=True,
                 )
                 progress.start()