Note Cypress.Commands.add() error
#5163
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
||
| ::: | ||
|
|
||
| :::caution |
There was a problem hiding this comment.
Instead of a callout half way down the page, can we just add it to the explanation of the two options for adding custom commands in the initial description before we list the syntax? https://docs.cypress.io/api/cypress-api/custom-commands
I would expect this up-front as an unfamiliar user so I knew what I needed to read and care about.
There was a problem hiding this comment.
Something like:
There are two API available for adding custom commands:
- Cypress.Commands.add() - use to add a custom command to use when writing tests
- Cypress.Command.overwrite() - use to override and existing built-in Cypress command or reserved internal function. Caution this overrides it for Cypress as well and could impact how Cypress behaves.
|
|
||
| ::: | ||
|
|
||
| :::caution |
There was a problem hiding this comment.
can we move above the info banner & just add to the text without the banner at all? Doesn't seem worthy calling out so loudly since this is what the doc is about
jaffrepaul
force-pushed
the
add-existing-commands
branch
from
848297d to
f404b5e
Compare
emilyrohrbough
approved these changes
Apr 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a reimplementation in the new site of an older PR that never made it in.