Update description on 'on' fail to explicitly call out that subsequen…

…t commands do not run when this is hit (#5554)
cypress-io · Nov 2, 2023 · 1773fd4 · 1773fd4
1 parent 43f4fc3
commit 1773fd4
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/docs/api/cypress-api/catalog-of-events.mdx b/docs/api/cypress-api/catalog-of-events.mdx
@@ -77,11 +77,11 @@ These are the most useful events for you to listen to.
 These events come from Cypress as it issues commands and reacts to their state.
 These are all useful to listen to for debugging purposes.
 
-| Event            | Details                                                                                                                                                                                                                                                                                                                                          |
-| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| **Name:**        | `fail`                                                                                                                                                                                                                                                                                                                                           |
-| **Yields:**      | the error **(Object)**, Mocha runnable **(Object)**                                                                                                                                                                                                                                                                                              |
-| **Description:** | Fires when the test has failed. Binding to this event without rethrowing the error will prevent the test from failing. However this is **strongly discouraged**. Tests should never legitimately fail. This event exists because it's extremely useful for debugging purposes. See our recipe [Handling errors](/examples/recipes#Fundamentals). |
+| Event            | Details                                                                                                                                                                                                                                                                                                                                                                                                    |
+| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Name:**        | `fail`                                                                                                                                                                                                                                                                                                                                                                                                     |
+| **Yields:**      | the error **(Object)**, Mocha runnable **(Object)**                                                                                                                                                                                                                                                                                                                                                        |
+| **Description:** | Fires when the test has failed. Binding to this event without rethrowing the error will prevent the test from having a 'failed' state. Subsequent commands will not be executed. However this is **strongly discouraged**. Tests should never legitimately fail. This event exists because it's extremely useful for debugging purposes. See our recipe [Handling errors](/examples/recipes#Fundamentals). |
 
 | Event            | Details                                                                                                                                                              |
 | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |