Skip to content

remove some inconsistencies with using 'headless' language #2251

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.

Sign up for GitHub

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

Merged
Parent: Added 'cypress-thenify' and IntelliJ plugins
merged 1 commit into from
Nov 18, 2019
Merged

remove some inconsistencies with using 'headless' language #2251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions source/api/cypress-api/browser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,11 @@ it('has correct Chrome specific css property', function () {
})
```

### Screenshot only in headless environment
### Screenshot only in headless browser

```javascript
Cypress.Commands.overwrite('screenshot', (originalFn, subject, name, options) => {
// only take screenshots in headless environment
// only take screenshots in headless browser
if (Cypress.browser.isHeadless) {
// return the original screenshot function
return originalFn(subject, name, options)
Expand All @@ -68,7 +68,7 @@ Cypress.Commands.overwrite('screenshot', (originalFn, subject, name, options) =>
return cy.log('No screenshot taken when headed')
})

// only takes in headless environment
// only takes in headless browser
cy.screenshot()
```

Expand Down
2 changes: 1 addition & 1 deletion source/guides/guides/continuous-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -615,7 +615,7 @@ Second, set the X11 address in an environment variable
export DISPLAY=:99
```

Start headless Cypress as usual
Start Cypress as usual

```shell
npx cypress run
Expand Down
2 changes: 1 addition & 1 deletion source/guides/references/best-practices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -541,7 +541,7 @@ cy.get('table tr').should('have.length', 2)
{% endnote %}

{% note success %}
{% fa fa-check-circle green %} **Best Practice:** Start a web server prior to running Cypress in the Test Runner or headless mode.
{% fa fa-check-circle green %} **Best Practice:** Start a web server prior to running Cypress.
{% endnote %}

We do NOT recommend trying to start your back end web server from within Cypress.
Expand Down