From 1773fd4c29a42131314e73c4a16086e07c456248 Mon Sep 17 00:00:00 2001 From: Jennifer Shehane Date: Thu, 2 Nov 2023 12:46:14 -0400 Subject: [PATCH] Update description on 'on' fail to explicitly call out that subsequent commands do not run when this is hit (#5554) --- docs/api/cypress-api/catalog-of-events.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/api/cypress-api/catalog-of-events.mdx b/docs/api/cypress-api/catalog-of-events.mdx index f168b49fac..d04db0e806 100644 --- 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 | | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |