Adjust code documentation

docs/development/forked-pr.md

@@ -8,7 +8,7 @@ id: forked-pr
 
 * Fork the Cumulus repo
 * Create a new branch from the branch you'd like to contribute to
-* If an issue does't already exist, submit one (see above)
+* If an issue doesn't already exist, submit one (see above)
 
 ## Create a Pull Request
 

packages/common/src/sleep.ts

@@ -1,5 +1,8 @@
 /**
  * Sleep for the given number of milliseconds
+ *
+ * @param {number} duration - The number of milliseconds to sleep.
+ * @returns {Promise} A `Promise` that resolves after the given duration.
  */
 export const sleep = (duration: number): Promise<void> =>
   new Promise((resolve) => setTimeout(resolve, duration));

packages/common/src/test-utils.ts

@@ -14,6 +14,7 @@ export const inTestMode = (env: NodeJS.ProcessEnv = process.env): boolean =>
 
 /**
  * Helper function to throw error for unit test exports
+ * 
  * @throws {Error}
  */
 export const throwTestError = () => {