Merge pull request #45 from slackhq/sg-add-docs

added docs

src/convert-test-files.ts

@@ -12,6 +12,14 @@ import {
 // Define the function type for LLM call
 export type LLMCallFunction = (prompt: string) => Promise<string>;
 
+/**
+ * Converts test files and processes them using the specified parameters.
+ *
+ * This function takes an array of test file paths and performs a series of operations
+ * including setting up the Jest environment, setting up configurations, and output paths.
+ * It also utilizes an LLM (Large Language Model) call function to process the test files.
+ * The results of the conversion are stored in the specified output directory.
+ */
 export const convertTestFiles = async ({
     filePaths,
     logLevel,

src/support/ast-transformations/individual-transformations/convert-mount-shallow-methods.ts

@@ -6,7 +6,7 @@
 		return shallow(<ReactComponent {...props} />);
 	}
  * Assumption: only one method is used: mount or shallow, but not both. 
- * TODO: fix this by collecting all the matched queries and return an array. See removeMountAndShallow.jest.tsx with all tests active
+ * Feature: fix this by collecting all the matched queries for shallowCall and mountCall. Now it handles cases with either mount shallow, but not both
  */
 
 import { JSCodeshift, Collection, CallExpression } from 'jscodeshift';