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

Fix findInPage() documentation for correcting type definition #10677

Merged
merged 1 commit into from Oct 3, 2017

Conversation

Projects
None yet
4 participants
@rhysd
Contributor

rhysd commented Oct 3, 2017

I found that return type of webContents.findInPage() and webview.findInPage() are void in electron.d.ts (electron v1.7.8).

But from document, they should return number which represents request ID. Although I'm not sure how the documents are converted into type definitions, return types don't seem to be recognized from the document correctly. I fixed documents to correct the return types.

Fix findInPage() documentation for correcting type definition
This update fixes the return type of `findInPage()`, which is currently
typed as `void` but actually it should be `number`.

@rhysd rhysd requested a review from electron/docs as a code owner Oct 3, 2017

@jkleinsc jkleinsc merged commit 93e40ee into electron:master Oct 3, 2017

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@zeke

This comment has been minimized.

Member

zeke commented Oct 3, 2017

Thanks, @rhysd!

@rhysd rhysd deleted the rhysd:fix-doc-findInPage branch Oct 4, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment