Skip to content
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

Add docs for requestTimeout and responseTimeout in cy.wait #1165

Merged
merged 2 commits into from
Dec 3, 2018
Merged

Add docs for requestTimeout and responseTimeout in cy.wait #1165

merged 2 commits into from
Dec 3, 2018

Conversation

jtymes
Copy link
Contributor

@jtymes jtymes commented Nov 23, 2018

Adding docs for new options introduced in cypress-io/cypress#2829.

@CLAassistant
Copy link

CLAassistant commented Nov 23, 2018

CLA assistant check
All committers have signed the CLA.

@jennifer-shehane
Copy link
Member

@jtymes Will this PR also not remove the generic 'timeout' option?

@jtymes
Copy link
Contributor Author

jtymes commented Nov 26, 2018

@jennifer-shehane I did not remove the timeout option. I went the safest route to prevent breaking existing tests that may be relying on that timeout option today. Do you have a guideline for deprecations?

@jennifer-shehane
Copy link
Member

Ok, we can update this after the PR is formally reviewed if needed.

We are beginning to incorporate a 'history' section into each command's doc, so that we can track changes like this. It has not been incorporated into every command yet, but is being added as we go forward. writefile has an example of history table. https://github.com/cypress-io/cypress-documentation/blob/develop/source/api/commands/writefile.md#L182

@brian-mann brian-mann merged commit 45cc1ed into cypress-io:develop Dec 3, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants