Skip to content

Commit 7398575

Browse files
committed
WIP: Updating documentation
1 parent ab70025 commit 7398575

22 files changed

+253
-257
lines changed

Sources/InlineSnapshotTesting/Documentation.docc/InlineSnapshotTesting.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Powerfully convenient snapshot testing.
88
alongside the test files. This makes for compact test cases with single line assertions...
99

1010
```swift
11-
assertSnapshot(of: value, as: .json)
11+
assert(of: value, as: .json)
1212
```
1313

1414
...but can make verification more cumbersome: one must find the corresponding file in order to
@@ -68,7 +68,10 @@ Re-run "testMySnapshot" to test against the newly-recorded snapshot.
6868

6969
### Essentials
7070

71-
- ``assertInline(of:as:message:record:timeout:closureDescriptor:matches:file:function:line:column:)``
71+
- ``assertInline(of:as:message:record:timeout:serialization:closureDescriptor:matches:fileID:file:function:line:column:)-(_,SyncSnapshot<Input, Output>,_,_,_,_,_,_,_,_,_,_,_)``
72+
- ``assertInline(of:as:message:record:timeout:serialization:closureDescriptor:matches:fileID:file:function:line:column:)-(_,AsyncSnapshot<Input, Output>,_,_,_,_,_,_,_,_,_,_,_)``
73+
- ``assertInline(of:as:message:record:timeout:name:serialization:closureDescriptor:matches:fileID:file:function:line:column:)-(_,SyncSnapshot<Input, Output>,_,_,_,_,_,_,_,_,_,_,_,_)``
74+
- ``assertInline(of:as:message:record:timeout:name:serialization:closureDescriptor:matches:fileID:file:function:line:column:)-(_,AsyncSnapshot<Input, Output>,_,_,_,_,_,_,_,_,_,_,_,_)``
7275

7376
### Writing a custom helper
7477

Sources/SnapshotTesting/Documentation.docc/Articles/CustomStrategies.md

Lines changed: 0 additions & 97 deletions
This file was deleted.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# ``SnapshotTesting``
2+
3+
<!--@START_MENU_TOKEN@-->Summary<!--@END_MENU_TOKEN@-->
4+
5+
## Overview
6+
7+
<!--@START_MENU_TOKEN@-->Text<!--@END_MENU_TOKEN@-->
8+
9+
## Topics
10+
11+
### <!--@START_MENU_TOKEN@-->Group<!--@END_MENU_TOKEN@-->
12+
13+
- <!--@START_MENU_TOKEN@-->``Symbol``<!--@END_MENU_TOKEN@-->

Sources/SnapshotTesting/Documentation.docc/Extensions/AssertSnapshot.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

Sources/SnapshotTesting/Documentation.docc/Extensions/Deprecations/SnapshotTestingDeprecations.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

Sources/SnapshotTesting/Documentation.docc/Extensions/Deprecations/diffTool-property-deprecation.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

Sources/SnapshotTesting/Documentation.docc/Extensions/Deprecations/isRecording-property-deprecation.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

Sources/SnapshotTesting/Documentation.docc/Extensions/Snapshotting.md

Lines changed: 0 additions & 63 deletions
This file was deleted.

Sources/SnapshotTesting/Documentation.docc/Extensions/WithSnapshotTesting.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

Sources/SnapshotTesting/Documentation.docc/SnapshotTesting.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)