doc: change ambiguous phrase in api.md #410
Merged
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
|
@ebidel Eric, what would you say? :) |
ebidel
reviewed
Aug 20, 2017
docs/api.md
Outdated
| @@ -1129,7 +1129,7 @@ The `elementHandle.dispose` method stops referencing the element handle. | |||
| - returns: <[Promise]<[Serializable]>> Promise which resolves to function return value | |||
|
|
|||
| If the function, passed to the `elementHandle.evaluate`, returns a [Promise], then `elementHandle.evaluate` would wait for the promise to resolve and return it's value. | |||
| The function will be passed in the element ifself as a first argument. | |||
| The element ifself will be passed in the function as a first argument. | |||
There was a problem hiding this comment.
I think it was intended to read as: "The element gets passed to pageFunction as a first argument."
However, is this true? Doesn't pageFunction get passed args, not the element handle? Maybe leftover from a previous time?
There was a problem hiding this comment.
Yes, this is still true: the element itself is passed as a first argument, followed by all the arguments. (note: this is elementHandle.evaluate, not page.evaluate)
There was a problem hiding this comment.
Ah ok. Then how about: "The element will be passed as the first argument to pageFunction, followed by any args."
vsemozhetbyt
force-pushed
the
api.md-ambiguous
branch
from
e26d893 to
ccfb1d8
Compare
aslushnikov
approved these changes
Aug 20, 2017
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.
I was a bit puzzled about what was passed in and where, but I am not a native speaker and may not be reliable here.
Please, close if the wording was OK.