API `cy.end` example fails to run

[MikeMcC399]

API `cy.end` example fails to run

[jennifer-shehane]

@MikeMcC399 Yah it's a weird little command. I don't totally understand why this would fail though. I wonder if this started in a more recent version like 12.0

[MikeMcC399]

@jennifer-shehane

Yah it's a weird little command. I don't totally understand why this would fail though. I wonder if this started in a more recent version like 12.0

I tested with earlier versions as well and all the ones I tested showed failure:

Node.js v20.11.1

Cypress version	result
10.11.0	failed
11.2.0	failed
12.7.4	failed
13.7.0	failed

Bottom line is that any example for cy.end() should work and should pass linting.

[MikeMcC399]

I don't have enough experience writing Cypress tests to be able to specify a good replacement example for the use of cy.end(), however I did find it used with Cypress.log:

e.g. log.end() in cypress-realworld-testing:

See https://learn.cypress.io/real-world-examples/custom-cypress-commands

Perhaps this could be used as an alternative?

[jennifer-shehane]

I think we should just remove the cy.end example. The kitchensink isn't exhaustive anyway and there's less utility for this command with the changes we've made to chaining.

[MikeMcC399]

@jennifer-shehane

Would you want to remove the examples from the documentation section API > Other Commands > end > Examples ?

Thank you for explaining about the history. I didn't know about that.

[jennifer-shehane]

If they're not working in these examples, we can remove them or come up with some example that does make sense to add. Something that's not chaining off of action commands I guess.