Makes wrap(promise) more prominent
#2664
Closed
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
As indicated in #1322 and ff, it needs to be immediately communicated to new user that using `.wrap` helps immensely with promises. just spend a few days ripping my hair out because I didn't see this before
jennifer-shehane
requested changes
Mar 27, 2020
There was a problem hiding this comment.
This should be specified in the ## Assertions section of the document - so needs to define a specific assertion in the https://github.com/cypress-io/cypress-documentation/blob/develop/lib/tags/assertions.js#L10:L10 tag for wrap that explains it retries until the promise resolves.
Then reference this definition here: https://github.com/cypress-io/cypress-documentation/blob/develop/source/api/commands/wrap.md#L161:L161
Adding an example to the Examples section of this would also be more ideal.
|
yeah, I just started with cypress, so I don't feel confident writing that
right now.
but I feel strongly that there should be some indication *at the top of the
page* that there are more uses for `wrap` then just wrapping a "dumb" data
structure. and that it is key to making many promise based approaches work.
I wasted like 2-3 days until I found that out and I must have looked at the
wrap page like 10-15 times while doing that
…__
Typed on a mobile, please excuse any typing mistakes or short-spokeness.
On Fri, Mar 27, 2020, 10:00 Jennifer Shehane ***@***.***> wrote:
***@***.**** requested changes on this pull request.
This should be specified in the ## Assertions section of the document - so
needs to define a specific assertion in the
https://github.com/cypress-io/cypress-documentation/blob/develop/lib/tags/assertions.js#L10:L10
tag for wrap that explains it retries until the promise resolves.
Then reference this definition here:
https://github.com/cypress-io/cypress-documentation/blob/develop/source/api/commands/wrap.md#L161:L161
Adding an example to the Examples section of this would also be more ideal.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#2664 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AB6WSHR7Z6ANUURXR77QOWDRJRTLXANCNFSM4LTLXJKA>
.
|
|
Closing in favor of #2689 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As indicated in #1322 and ff, it needs to be immediately communicated to new user that using
.wraphelps immensely with promises.just spend a few days ripping my hair out because I didn't see this before