Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: updating missing docs rev2 #113

Merged
merged 2 commits into from
Aug 28, 2023
Merged

docs: updating missing docs rev2 #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c96cb3e
docs: fixing merge conflicting docs
aorumbayev Aug 28, 2023
5e2b80d
chore: adjusting ci not to ignore .md files to trigger pr checks
aorumbayev Aug 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .github/workflows/pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ name: Pull Request
on:
pull_request:
branches: [main]
paths-ignore:
- '**/*.md'

permissions:
contents: read
Expand Down
18 changes: 9 additions & 9 deletions docs/code/classes/testing.TestLogger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,15 +168,6 @@ 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 |
Expand All @@ -189,6 +180,15 @@ expect(logger.getLogSnapshot()).toMatchSnapshot()

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)
Expand Down
8 changes: 4 additions & 4 deletions docs/code/classes/types_logic_error.LogicError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,10 +153,6 @@ ___

Optional override for formatting stack traces

**`See`**

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

##### Parameters

| Name | Type |
Expand All @@ -168,6 +164,10 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces

`any`

**`See`**

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

#### Inherited from

Error.prepareStackTrace
Expand Down
8 changes: 4 additions & 4 deletions docs/code/interfaces/types_testing.AlgorandFixture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ 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
Expand All @@ -53,10 +57,6 @@ 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)
Loading
Loading