Add comment explaining -old suffix

temporalio · Nov 22, 2023 · 40dbd13 · 40dbd13
1 parent 06a82d6
commit 40dbd13
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/packages/test/src/integration-tests-old.ts b/packages/test/src/integration-tests-old.ts
@@ -1,4 +1,10 @@
 /* eslint @typescript-eslint/no-non-null-assertion: 0 */
+
+/**
+ * Our most recent style of integration tests are those in the
+ * integration-tests/ directory. This file has been given the suffix -old to
+ * distinguish the different variants.
+ */
 import path from 'node:path';
 import v8 from 'node:v8';
 import { readFileSync } from 'node:fs';

diff --git a/packages/test/src/test-integration-codec-old.ts b/packages/test/src/test-integration-codec-old.ts
@@ -1,3 +1,9 @@
+/**
+ * Our most recent style of integration tests are those in the
+ * integration-tests/ directory. This file has been given the suffix -old to
+ * distinguish the different variants.
+ */
+
 import { RUN_INTEGRATION_TESTS, ByteSkewerPayloadCodec } from './helpers';
 import { runIntegrationTests } from './integration-tests-old';
 

diff --git a/packages/test/src/test-integration-old.ts b/packages/test/src/test-integration-old.ts
@@ -1,3 +1,9 @@
+/**
+ * Our most recent style of integration tests are those in the
+ * integration-tests/ directory. This file has been given the suffix -old to
+ * distinguish the different variants.
+ */
+
 import { RUN_INTEGRATION_TESTS } from './helpers';
 import { runIntegrationTests } from './integration-tests-old';