Browse Source

docs: Improve description of findInPage options (#29146)

* docs: improve webContents.findInPage description

* docs: improve webview.findInPage description

Co-authored-by: PalmerAL <[email protected]>
trop[bot] 3 years ago
parent
commit
ff1cc3c60b
2 changed files with 2 additions and 4 deletions
  1. 1 2
      docs/api/web-contents.md
  2. 1 2
      docs/api/webview-tag.md

+ 1 - 2
docs/api/web-contents.md

@@ -1321,8 +1321,7 @@ Inserts `text` to the focused element.
 * `text` String - Content to be searched, must not be empty.
 * `options` Object (optional)
   * `forward` Boolean (optional) - Whether to search forward or backward, defaults to `true`.
-  * `findNext` Boolean (optional) - Whether the operation is first request or a follow up,
-    defaults to `false`.
+  * `findNext` Boolean (optional) - Whether to begin a new text finding session with this request. Should be `true` for initial requests, and `false` for follow-up requests. Defaults to `false`.
   * `matchCase` Boolean (optional) - Whether search should be case-sensitive,
     defaults to `false`.
 

+ 1 - 2
docs/api/webview-tag.md

@@ -515,8 +515,7 @@ Inserts `text` to the focused element.
 * `text` String - Content to be searched, must not be empty.
 * `options` Object (optional)
   * `forward` Boolean (optional) - Whether to search forward or backward, defaults to `true`.
-  * `findNext` Boolean (optional) - Whether the operation is first request or a follow up,
-    defaults to `false`.
+  * `findNext` Boolean (optional) - Whether to begin a new text finding session with this request. Should be `true` for initial requests, and `false` for follow-up requests. Defaults to `false`.
   * `matchCase` Boolean (optional) - Whether search should be case-sensitive,
     defaults to `false`.