Document VscodeFilesystem.readFileUtf8FromRoot.

cursorless-dev · Jan 23, 2024 · 7d9cb22 · 7d9cb22
1 parent 9f6a30f
commit 7d9cb22
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/cursorless-vscode/src/ide/vscode/VscodeFileSystem.ts b/packages/cursorless-vscode/src/ide/vscode/VscodeFileSystem.ts
@@ -42,6 +42,13 @@ export class VscodeFileSystem implements FileSystem {
     return path.substring(0, path.lastIndexOf("/"));
   }
 
+  /**
+   * Reads a file under the extensionUri of the extensionContext passed to
+   * the constructor.
+   *
+   * @param path path to read
+   * @returns the contents of path, decoded as UTF-8
+   */
   public async readFileUtf8FromRoot(path: string): Promise<string> {
     return this.decoder.decode(
       await vscode.workspace.fs.readFile(