updated docs

customerio · Sep 15, 2023 · beeb653 · beeb653
1 parent f24e1ad
commit beeb653
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/common-test/src/main/java/io/customer/commontest/BaseTest.kt b/common-test/src/main/java/io/customer/commontest/BaseTest.kt
@@ -22,7 +22,9 @@ import retrofit2.HttpException
 import retrofit2.Response
 
 /**
- * Base class for a unit test class to subclass. If you want to create integration tests, use [BaseIntegrationTest].
+ * Base class for a test class to subclass. Do not inherit this class directly.
+ * - If you want to create unit tests, use [BaseUnitTest].
+ * - If you want to create integration tests, use [BaseIntegrationTest].
  * Meant to provide convenience to test classes with properties and functions tests may use.
  */
 abstract class BaseTest {

diff --git a/common-test/src/main/java/io/customer/commontest/BaseUnitTest.kt b/common-test/src/main/java/io/customer/commontest/BaseUnitTest.kt
@@ -12,6 +12,10 @@ import io.customer.sdk.util.Logger
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.whenever
 
+/**
+ * Base class for a unit test class to subclass. If you want to create integration tests, use [BaseIntegrationTest].
+ * Meant to provide convenience to test classes with properties and functions tests may use.
+ */
 abstract class BaseUnitTest : BaseTest() {
 
     override val application: Application = mock<Application>().apply {