This repository has been archived by the owner on Jul 14, 2020. It is now read-only.
Pass through all docs and make consistant (and correct minor issues) #52
Conversation
This file contains 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
wwilsman
reviewed
Oct 10, 2018
src/interactions/find-all.js
Outdated
| * } | ||
| * ``` | ||
| * | ||
| * ``` javascript | ||
| * let $listItems = await new ListInteractor('ul').getItems() | ||
| * let $listItems = await new ListInteractor('ul').items; |
src/interactions/find.js
Outdated
| * } | ||
| * ``` | ||
| * | ||
| * ``` javascript | ||
| * let $heading = await new PageInteractor().getHeading() | ||
| * let $heading = await new PageInteractor().heading; |
There was a problem hiding this comment.
No need to await here either
wwilsman
reviewed
Oct 10, 2018
src/interactions/find-all.js
Outdated
| @@ -6,7 +6,7 @@ import { computed } from './helpers'; | |||
| * matching the provided selector. | |||
| * | |||
| * ``` javascript | |||
| * let $listItems = await new Interactor('ul').findAll('li'); | |||
| * let $listItems = new Interactor('ul').findAll('li'); | |||
There was a problem hiding this comment.
The methods find and findAll still needs to await. The property creators do not. You can see in the two function bodies for each one returns a convergence and the other returns a computed element.
The methods are used to wait for elements to exist, and the created properties can be used inside convergent assertions.
There was a problem hiding this comment.
Ahhh, gotcha. That makes sense
Robdel12
force-pushed
the
rd/passthrough-docs
branch
from
a7011c7
to
6b8ae82
Compare
wwilsman
approved these changes
Oct 10, 2018
Merged
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What is this?
With #51 being merged through it was a good time to go through and make all of our inline docs consistent in style. With a fresh pair of eyes I went through all of the docs and double checked everything. It's possible I missed things, so please double check!
This will close #25