minor #20331 [Console] Update FinishedIndicator documentation for Progress indicator (LauLaman)

javiereguiluz · javiereguiluz · commit f02c2ab60450 · 2024-10-16T16:18:48.000+02:00
This PR was merged into the 7.2 branch. Discussion ---------- [Console] Update FinishedIndicator documentation for Progress indicator Hi! This is a correction to PR #20300 Which makes a wrong statement about the finished indicator. This MR seeks to resolve this and make the documentation more clear closes #20296 Commits ------- 93ca378 Update progressindicator.rst
diff --git a/components/console/helpers/progressindicator.rst b/components/console/helpers/progressindicator.rst
@@ -44,18 +44,21 @@ level of verbosity of the ``OutputInterface`` instance:
      | Processing...
      / Processing...
      - Processing...
+     ✔ Finished
 
     # OutputInterface::VERBOSITY_VERBOSE (-v)
      \ Processing... (1 sec)
      | Processing... (1 sec)
      / Processing... (1 sec)
      - Processing... (1 sec)
+     ✔ Finished (1 sec)
 
     # OutputInterface::VERBOSITY_VERY_VERBOSE (-vv) and OutputInterface::VERBOSITY_DEBUG (-vvv)
      \ Processing... (1 sec, 6.0 MiB)
      | Processing... (1 sec, 6.0 MiB)
      / Processing... (1 sec, 6.0 MiB)
      - Processing... (1 sec, 6.0 MiB)
+     ✔ Finished (1 sec, 6.0 MiB)
 
 .. tip::
 
@@ -94,22 +97,23 @@ The progress indicator will now look like this:
      ⠛ Processing...
      ⠹ Processing...
      ⢸ Processing...
+     ✔ Finished
 
-Once the progress indicator is finished, it keeps the latest indicator value by
-default. You can replace it with your own::
+Once the progress indicator is finished, it uses the finishedIndicator value (which defaults to ✔). You can replace it with your own::
 
-    $progressIndicator->finish('Finished', '✅');
-
-Then the progress indicator will render like this:
-
-.. code-block:: text
+    $progressIndicator = new ProgressIndicator($output, 'verbose', 100, null, '🎉');
+    
+    try {
+        /* do something */
+        $progressIndicator->finish('Finished');
+    } catch (\Exception) {
+        $progressIndicator->finish('Failed', '🚨');
+    }
 
-     ⠏ Processing...
-     ⠛ Processing...
-     ✅ Finished
 
 .. versionadded:: 7.2
 
+    The ``finishedIndicator`` parameter for the constructor was introduced in Symfony 7.2.
     The ``finishedIndicator`` parameter for method ``finish()`` was introduced in Symfony 7.2.
 
 Customize Placeholders
