Skip to content

Commit 4e2aa98

Browse files
authored
findfiles2 doc clarity improvements (microsoft#205902)
1 parent 52cb4e4 commit 4e2aa98

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/vscode-dts/vscode.proposed.findFiles2.d.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,14 @@ declare module 'vscode' {
5454

5555
/**
5656
* Whether symlinks should be followed while searching.
57-
* See the vscode setting `"search.followSymlinks"`.
57+
* Defaults to the value for `search.followSymlinks` in settings.
58+
* For more info, see the setting listed above.
5859
*/
5960
followSymlinks?: boolean;
6061

6162
/**
6263
* If set to true, the `filePattern` arg will be fuzzy-searched instead of glob-searched.
63-
* If `filePattern` is a `GlobPattern`, then the fuzzy search will act on the `pattern` of the `RelativePattern`
64+
* If `filePattern` is a {@link RelativePattern relative pattern}, then the fuzzy search will act on the `pattern` of the {@link RelativePattern RelativePattern}
6465
*/
6566
fuzzy?: boolean;
6667
}
@@ -73,7 +74,7 @@ declare module 'vscode' {
7374
* Find files across all {@link workspace.workspaceFolders workspace folders} in the workspace.
7475
*
7576
* @example
76-
* findFiles('**​/*.js', {exclude: '**​/out/**', useIgnoreFiles: true}, 10)
77+
* findFiles('**​/*.js', {exclude: '**​/out/**', useIgnoreFiles: true, maxResults: 10})
7778
*
7879
* @param filePattern A {@link GlobPattern glob pattern} that defines the files to search for. The glob pattern
7980
* will be matched against the file paths of resulting matches relative to their workspace. Use a {@link RelativePattern relative pattern}

0 commit comments

Comments
 (0)