-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Harmonize cypress script example names cy: #5787
Harmonize cypress script example names cy: #5787
Conversation
👷 Deploy request for cypress-docs pending review.Visit the deploys page to approve it
|
|
✅ Deploy Preview for benevolent-cat-040f48 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
@MikeMcC399 Is this ready for review? |
I'm probably going to suggest re-doing this section, so this PR may become obsolete in the long run. You can ignore it so long as it is in draft. Thanks! |
I'm putting this minor PR up for review now as it may be a while before I get back to contributing other content here.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good.
Issue
The section Getting Started > Opening the App > Adding npm Scripts uses the following examples as script names:
cypress:open
cypress:run
whereas all other examples of script names on the documentation site use
cy:open
orcy:run
.Change
Change the script name examples in the section Getting Started > Opening the App > Adding npm Scripts to use the following script names:
cy:open
cy:run
This harmonizes the example usage with the rest of the documentation site. It is also in line with the usage in cypress-io/cypress-example-kitchensink > package.json.
BEFORE
AFTER