From d5c3af89ab8076bcf4107859c1ba6b47a7815142 Mon Sep 17 00:00:00 2001
From: Akshay Nair <phenax5@gmail.com>
Date: Sun, 15 Jan 2023 00:13:04 +0530
Subject: chore: some more documentation

---
 docs/modules/test.md | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

(limited to 'docs/modules/test.md')

diff --git a/docs/modules/test.md b/docs/modules/test.md
index dc0ec99..df117e3 100644
--- a/docs/modules/test.md
+++ b/docs/modules/test.md
@@ -21,6 +21,25 @@
 
 Ƭ **AssertEquals**<`Left`, `Right`\>: [`Try`](../interfaces/exception.Try.md)<[`Assert`](../interfaces/test.Assert.md)<[`Equals`](util.md#equals)<`Left`, `Right`\>\>, <m\>() => [`Do`](../interfaces/effect.Do.md)<[[`ShowAssertionError`](../interfaces/test.ShowAssertionError.md)<`Left`, `Right`\>, [`Throw`](../interfaces/exception.Throw.md)<`m`\>]\>\>
 
+Assert if left and right values are equal structurally
+
+**`Type Param`**
+
+Left value
+
+**`Type Param`**
+
+Right value
+
+**`Example`**
+
+```ts
+type main = [
+  AssertEquals<`Foo ${'bar'}`, 'Foo bar'>
+  AssertEquals<[2, ...[3, 4]], [2, 3, 4]>
+]
+```
+
 #### Type parameters
 
 | Name |
@@ -30,4 +49,4 @@
 
 #### Defined in
 
-[test.ts:28](https://github.com/phenax/ts-types-runtime-environment/blob/78e384c/stdlib/test.ts#L28)
+[test.ts:59](https://github.com/phenax/ts-types-runtime-environment/blob/e75a5a1/stdlib/test.ts#L59)
-- 
cgit v1.3.1