From de4949571cd4873116f8243a4e15d74a6b01c309 Mon Sep 17 00:00:00 2001 From: Asher Date: Tue, 10 Nov 2020 17:02:39 -0600 Subject: [PATCH] Document getFirstPath better --- src/node/vscode.ts | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/src/node/vscode.ts b/src/node/vscode.ts index 92d749447..da7d5710a 100644 --- a/src/node/vscode.ts +++ b/src/node/vscode.ts @@ -165,7 +165,16 @@ export class VscodeProvider { } /** - * Choose the first non-empty path. + * Choose the first non-empty path from the provided array. + * + * Each array item consists of `url` and an optional `workspace` boolean that + * indicates whether that url is for a workspace. + * + * `url` can be a fully qualified URL or just the path portion. + * + * `url` can also be a query object to make it easier to pass in query + * variables directly but anything that isn't a string or string array is not + * valid and will be ignored. */ private async getFirstPath( startPaths: Array<{ url?: string | string[] | ipc.Query | ipc.Query[]; workspace?: boolean } | undefined>,