Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonCropp committed Dec 28, 2019
1 parent cbdafdf commit d1e3cd2
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ var snippetExtractor = new DirectorySnippetExtractor(
!dirPath.EndsWith("obj"));
var snippets = snippetExtractor.ReadSnippets(@"C:\path");
```
<sup><a href='/src/Tests/Snippets/Usage.cs#L40-L49' title='File snippet `readingdirectorysimple` was extracted from'>snippet source</a> | <a href='#snippet-readingdirectorysimple' title='Navigate to start of snippet `readingdirectorysimple`'>anchor</a></sup>
<sup><a href='/src/Tests/Snippets/Usage.cs#L42-L51' title='File snippet `readingdirectorysimple` was extracted from'>snippet source</a> | <a href='#snippet-readingdirectorysimple' title='Navigate to start of snippet `readingdirectorysimple`'>anchor</a></sup>
<!-- endsnippet -->


Expand Down Expand Up @@ -77,7 +77,7 @@ var missingSnippets = result.MissingSnippets;
// snippets that the markdown file used
var usedSnippets = result.UsedSnippets;
```
<sup><a href='/src/Tests/Snippets/Usage.cs#L54-L86' title='File snippet `markdownprocessingsimple` was extracted from'>snippet source</a> | <a href='#snippet-markdownprocessingsimple' title='Navigate to start of snippet `markdownprocessingsimple`'>anchor</a></sup>
<sup><a href='/src/Tests/Snippets/Usage.cs#L56-L88' title='File snippet `markdownprocessingsimple` was extracted from'>snippet source</a> | <a href='#snippet-markdownprocessingsimple' title='Navigate to start of snippet `markdownprocessingsimple`'>anchor</a></sup>
<!-- endsnippet -->


Expand Down
6 changes: 4 additions & 2 deletions docs/max-width.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,12 @@ The Max Width setting is used to control the maximum characters per line of a sn
<!-- snippet: DirectoryMarkdownProcessorRunMaxWidth -->
<a id='snippet-directorymarkdownprocessorrunmaxwidth'/></a>
```cs
var processor = new DirectoryMarkdownProcessor("targetDirectory", maxWidth: 80);
var processor = new DirectoryMarkdownProcessor(
"targetDirectory",
maxWidth: 80);
processor.Run();
```
<sup><a href='/src/Tests/Snippets/Usage.cs#L30-L35' title='File snippet `directorymarkdownprocessorrunmaxwidth` was extracted from'>snippet source</a> | <a href='#snippet-directorymarkdownprocessorrunmaxwidth' title='Navigate to start of snippet `directorymarkdownprocessorrunmaxwidth`'>anchor</a></sup>
<sup><a href='/src/Tests/Snippets/Usage.cs#L30-L37' title='File snippet `directorymarkdownprocessorrunmaxwidth` was extracted from'>snippet source</a> | <a href='#snippet-directorymarkdownprocessorrunmaxwidth' title='Navigate to start of snippet `directorymarkdownprocessorrunmaxwidth`'>anchor</a></sup>
<!-- endsnippet -->


Expand Down
2 changes: 1 addition & 1 deletion src/ConfigReader.Tests/ConfigReader.Tests.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<ItemGroup>
<ProjectReference Include="..\ConfigReader\ConfigReader.csproj" />
<PackageReference Include="XunitContext" Version="1.5.2" />
<PackageReference Include="Verify.Xunit" Version="1.4.1" />
<PackageReference Include="Verify.Xunit" Version="1.5.2" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.1" />
<PackageReference Include="Xunit" Version="2.4.1" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.4.0" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Language: 'tmp',
Value: 'Foo',
Error: '',
FileLocation: 'FilePath.txt(1-1)',
FileLocation: 'TempPath\File.tmp(1-1)',
IsInError: false
}
]
4 changes: 3 additions & 1 deletion src/Tests/Snippets/Usage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ void DirectoryMarkdownProcessorRunMaxWidth()
{
#region DirectoryMarkdownProcessorRunMaxWidth

var processor = new DirectoryMarkdownProcessor("targetDirectory", maxWidth: 80);
var processor = new DirectoryMarkdownProcessor(
"targetDirectory",
maxWidth: 80);
processor.Run();

#endregion
Expand Down
2 changes: 1 addition & 1 deletion src/Tests/Tests.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<Folder Include="DirectorySnippetExtractor\VerifyLambdasAreCalled\subpath\" />
<Folder Include="GitDirs\" />
<PackageReference Include="XunitContext" Version="1.5.2" />
<PackageReference Include="Verify.Xunit" Version="1.4.1" />
<PackageReference Include="Verify.Xunit" Version="1.5.2" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.1" />
<PackageReference Include="Xunit" Version="2.4.1" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.4.0" />
Expand Down

0 comments on commit d1e3cd2

Please sign in to comment.