?

DeterminateSystems · May 6, 2024 · dacc9e8 · dacc9e8
1 parent b3a6bdf
commit dacc9e8
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 13 deletions.
diff --git a/dist/index.d.ts b/dist/index.d.ts
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/index.ts b/src/index.ts
@@ -204,12 +204,14 @@ export class IdsToolbox {
     this.recordEvent(`begin_${this.executionPhase}`);
   }
 
-  // Attach a file to the diagnostics data in error conditions.
-  //
-  // The file at `location` doesn't need to exist when stapleFile is called.
-  //
-  // If the file doesn't exist or is unreadable when trying to staple the attachments, the JS error will be stored in a context value at `staple_failure_{name}`.
-  // If the file is readable, the file's contents will be stored in a context value at `staple_value_{name}`.
+  /**
+   * Attach a file to the diagnostics data in error conditions.
+   *
+   * The file at `location` doesn't need to exist when stapleFile is called.
+   *
+   * If the file doesn't exist or is unreadable when trying to staple the attachments, the JS error will be stored in a context value at `staple_failure_{name}`.
+   * If the file is readable, the file's contents will be stored in a context value at `staple_value_{name}`.
+   */
   stapleFile(name: string, location: string): void {
     this.exceptionAttachments.set(name, location);
   }