Skip to content

docs: fix screenshot blackout wording in documentation #2240

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
merged 2 commits into from
Nov 18, 2019
Merged

docs: fix screenshot blackout wording in documentation #2240

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0bcdf02
Update screenshot-api.md
mwaz Nov 12, 2019
8d16838
Merge branch 'develop' into fix/screenshot-wording-change
mwaz Nov 13, 2019
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
2 changes: 1 addition & 1 deletion source/api/cypress-api/screenshot-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Option | Default | Description

## Blackout elements before screenshot

Elements that match the specified selectors will be blacked out from the screenshot, but only when the `capture` option is `viewport`. `blackout` is ignored is `capture` is `runner`.
Elements that match the specified selectors will be blacked out from the screenshot, but only when the `capture` option is `viewport`. `blackout` is ignored if `capture` option is `runner`.

```javascript
Cypress.Screenshot.defaults({
Expand Down