Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonCropp committed Dec 19, 2022
1 parent 4249089 commit 4cb4b7b
Show file tree
Hide file tree
Showing 8 changed files with 40 additions and 20 deletions.
32 changes: 21 additions & 11 deletions docs/append-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,29 +10,39 @@ To change this file edit the source file and then run MarkdownSnippets.
Allows extra files to be verified in addition to the primary target.


## Binary
## AppendFile

<!-- snippet: BinaryFluent -->
<a id='snippet-binaryfluent'></a>
<!-- snippet: AppendFile -->
<a id='snippet-appendfile'></a>
```cs
[Fact]
public Task BinaryFluent() =>
public Task AppendFile() =>
Verify("Foo", settings)
.AppendFile(File.OpenRead("sample.png"));
.AppendFile("sample.png");
```
<sup><a href='/src/Verify.Tests/Converters/InstanceFileAppenderTests.cs#L21-L28' title='Snippet source file'>snippet source</a> | <a href='#snippet-binaryfluent' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Verify.Tests/Converters/InstanceFileAppenderTests.cs#L21-L28' title='Snippet source file'>snippet source</a> | <a href='#snippet-appendfile' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

Will result in two files being verified:

## Text
* `Tests.AppendFile#00.verified.txt` containing `Foo`
* `Tests.AppendFile#sample.verified.png`

<!-- snippet: TextFluent -->
<a id='snippet-textfluent'></a>

## AppendContentAsFile

<!-- snippet: AppendContentAsFile -->
<a id='snippet-appendcontentasfile'></a>
```cs
[Fact]
public Task TextFluent() =>
public Task AppendContentAsFile() =>
Verify("Foo")
.AppendContentAsFile("extra content");
```
<sup><a href='/src/Verify.Tests/Converters/InstanceFileAppenderTests.cs#L30-L37' title='Snippet source file'>snippet source</a> | <a href='#snippet-textfluent' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Verify.Tests/Converters/InstanceFileAppenderTests.cs#L30-L37' title='Snippet source file'>snippet source</a> | <a href='#snippet-appendcontentasfile' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

Will result in two files being verified:

* `Tests.AppendContentAsFile#00.verified.txt` containing `Foo`
* `Tests.AppendContentAsFile#01.verified.txt` containing `extra content`
18 changes: 14 additions & 4 deletions docs/mdsource/append-file.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,21 @@
Allows extra files to be verified in addition to the primary target.


## Binary
## AppendFile

snippet: BinaryFluent
snippet: AppendFile

Will result in two files being verified:

## Text
* `Tests.AppendFile#00.verified.txt` containing `Foo`
* `Tests.AppendFile#sample.verified.png`

snippet: TextFluent

## AppendContentAsFile

snippet: AppendContentAsFile

Will result in two files being verified:

* `Tests.AppendContentAsFile#00.verified.txt` containing `Foo`
* `Tests.AppendContentAsFile#01.verified.txt` containing `extra content`
10 changes: 5 additions & 5 deletions src/Verify.Tests/Converters/InstanceFileAppenderTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,19 @@ public InstanceFileAppenderTests()
Verify("Foo", settings)
.AppendContentAsFile("extra content", name: "theName");

#region BinaryFluent
#region AppendFile

[Fact]
public Task BinaryFluent() =>
public Task AppendFile() =>
Verify("Foo", settings)
.AppendFile(File.OpenRead("sample.png"));
.AppendFile("sample.png");

#endregion

#region TextFluent
#region AppendContentAsFile

[Fact]
public Task TextFluent() =>
public Task AppendContentAsFile() =>
Verify("Foo")
.AppendContentAsFile("extra content");

Expand Down

0 comments on commit 4cb4b7b

Please sign in to comment.