Skip to content

Commit de49495

Browse files
committed
Document getFirstPath better
1 parent 0a01338 commit de49495

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

src/node/vscode.ts

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,16 @@ export class VscodeProvider {
165165
}
166166

167167
/**
168-
* Choose the first non-empty path.
168+
* Choose the first non-empty path from the provided array.
169+
*
170+
* Each array item consists of `url` and an optional `workspace` boolean that
171+
* indicates whether that url is for a workspace.
172+
*
173+
* `url` can be a fully qualified URL or just the path portion.
174+
*
175+
* `url` can also be a query object to make it easier to pass in query
176+
* variables directly but anything that isn't a string or string array is not
177+
* valid and will be ignored.
169178
*/
170179
private async getFirstPath(
171180
startPaths: Array<{ url?: string | string[] | ipc.Query | ipc.Query[]; workspace?: boolean } | undefined>,

0 commit comments

Comments
 (0)