docs: adding generated docs

algorandfoundation · Aug 31, 2023 · 0931e5d · 0931e5d
1 parent 05fc667
commit 0931e5d
Show file tree

Hide file tree

Showing 6 changed files with 188 additions and 189 deletions.
diff --git a/docs/code/classes/testing.TestLogger.md b/docs/code/classes/testing.TestLogger.md
@@ -168,6 +168,15 @@ This helps ensure that the provided configuration items won't appear
 
 https://jestjs.io/docs/snapshot-testing#2-tests-should-be-deterministic
 
+**`Example`**
+
+Jest Example
+```typescript
+const logger = new TestLogger()
+...
+expect(logger.getLogSnapshot()).toMatchSnapshot()
+```
+
 #### Parameters
 
 | Name | Type | Description |
@@ -180,15 +189,6 @@ https://jestjs.io/docs/snapshot-testing#2-tests-should-be-deterministic
 
 The snapshotted logs.
 
-**`Example`**
-
-Jest Example
-```typescript
-const logger = new TestLogger()
-...
-expect(logger.getLogSnapshot()).toMatchSnapshot()
-```
-
 #### Defined in
 
 [src/testing/test-logger.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L47)

diff --git a/docs/code/classes/types_logic_error.LogicError.md b/docs/code/classes/types_logic_error.LogicError.md
@@ -153,6 +153,10 @@ ___
 
 Optional override for formatting stack traces
 
+**`See`**
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
 ##### Parameters
 
 | Name | Type |
@@ -164,10 +168,6 @@ Optional override for formatting stack traces
 
 `any`
 
-**`See`**
-
-https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-
 #### Inherited from
 
 Error.prepareStackTrace

diff --git a/docs/code/interfaces/types_testing.AlgorandFixture.md b/docs/code/interfaces/types_testing.AlgorandFixture.md
@@ -45,10 +45,6 @@ Testing framework agnostic handler method to run before each test to prepare the
 Retrieve the current context.
 Useful with destructuring.
 
-#### Returns
-
-[`AlgorandTestAutomationContext`](types_testing.AlgorandTestAutomationContext.md)
-
 **`Example`**
 
 ```typescript
@@ -57,6 +53,10 @@ test('My test', () => {
 })
 ```
 
+#### Returns
+
+[`AlgorandTestAutomationContext`](types_testing.AlgorandTestAutomationContext.md)
+
 #### Defined in
 
 [src/types/testing.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L63)