Skip to content

Commit

Permalink
cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonCropp committed Sep 29, 2021
1 parent 52c5606 commit b20ebb5
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 24 deletions.
2 changes: 1 addition & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ var files = Directory.EnumerateFiles(@"C:\path", "*.cs", SearchOption.AllDirecto

var snippets = FileSnippetExtractor.Read(files);
```
<sup><a href='/src/Tests/Snippets/Usage.cs#L8-L14' title='Snippet source file'>snippet source</a> | <a href='#snippet-readingfilessimple' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Snippets/Usage.cs#L7-L13' title='Snippet source file'>snippet source</a> | <a href='#snippet-readingfilessimple' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->


Expand Down
4 changes: 2 additions & 2 deletions docs/exclusion.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ When scanning for snippets the following are ignored:
"zip",
"zipx"
```
<sup><a href='/src/MarkdownSnippets/Reading/Exclusions/SnippetFileExclusions.cs#L32-L301' title='Snippet source file'>snippet source</a> | <a href='#snippet-binaryfileextensions' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/MarkdownSnippets/Reading/Exclusions/SnippetFileExclusions.cs#L30-L299' title='Snippet source file'>snippet source</a> | <a href='#snippet-binaryfileextensions' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

* Files that cannot contain comments:
Expand All @@ -330,5 +330,5 @@ When scanning for snippets the following are ignored:
"json",
"geojson"
```
<sup><a href='/src/MarkdownSnippets/Reading/Exclusions/SnippetFileExclusions.cs#L23-L27' title='Snippet source file'>snippet source</a> | <a href='#snippet-noacceptcommentsextensions' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/MarkdownSnippets/Reading/Exclusions/SnippetFileExclusions.cs#L21-L25' title='Snippet source file'>snippet source</a> | <a href='#snippet-noacceptcommentsextensions' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->
2 changes: 1 addition & 1 deletion docs/max-width.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ DirectoryMarkdownProcessor processor = new(
snippetDirectoryIncludes: _ => true);
processor.Run();
```
<sup><a href='/src/Tests/Snippets/Usage.cs#L33-L43' title='Snippet source file'>snippet source</a> | <a href='#snippet-directorymarkdownprocessorrunmaxwidth' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Snippets/Usage.cs#L32-L42' title='Snippet source file'>snippet source</a> | <a href='#snippet-directorymarkdownprocessorrunmaxwidth' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->


Expand Down
19 changes: 9 additions & 10 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,18 +270,17 @@ mdsnippets --omit-snippet-links true
<!-- snippet: LinkFormat.cs -->
<a id='snippet-LinkFormat.cs'></a>
```cs
namespace MarkdownSnippets
namespace MarkdownSnippets;

public enum LinkFormat
{
public enum LinkFormat
{
GitHub,
Tfs,
Bitbucket,
GitLab
}
GitHub,
Tfs,
Bitbucket,
GitLab
}
```
<sup><a href='/src/MarkdownSnippets/Processing/LinkFormat.cs#L1-L10' title='Snippet source file'>snippet source</a> | <a href='#snippet-LinkFormat.cs' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/MarkdownSnippets/Processing/LinkFormat.cs#L1-L9' title='Snippet source file'>snippet source</a> | <a href='#snippet-LinkFormat.cs' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->


Expand Down Expand Up @@ -310,7 +309,7 @@ if (linkFormat == LinkFormat.GitLab)
return $"{path}#L{snippet.StartLine}-{snippet.EndLine}";
}
```
<sup><a href='/src/MarkdownSnippets/Processing/SnippetMarkdownHandling.cs#L117-L137' title='Snippet source file'>snippet source</a> | <a href='#snippet-buildlink' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/MarkdownSnippets/Processing/SnippetMarkdownHandling.cs#L112-L132' title='Snippet source file'>snippet source</a> | <a href='#snippet-buildlink' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,18 @@ image: Visual Studio 2019
skip_commits:
message: /docs|Merge pull request.*/
build_script:
- ps: >-
dotnet build src --configuration Release

dotnet test src --configuration Release --no-build --no-restore
- pwsh: |
Invoke-WebRequest "https://dot.net/v1/dotnet-install.ps1" -OutFile "./dotnet-install.ps1"
./dotnet-install.ps1 -JSonFile src/global.json -Architecture x64 -InstallDir 'C:\Program Files\dotnet'
- dotnet build src --configuration Release
- dotnet test src --configuration Release --no-build --no-restore
test: off
artifacts:
- path: nugets\*.nupkg
on_failure:
- ps: Get-ChildItem *.received.* -recurse | % { Push-AppveyorArtifact $_.FullName -FileName $_.Name },
Error: ,
FileLocation: https://raw.githubusercontent.com/SimonCropp/MarkdownSnippets/master/src/appveyor.yml(1-13),
FileLocation: https://raw.githubusercontent.com/SimonCropp/MarkdownSnippets/master/src/appveyor.yml(1-14),
IsInError: false
}
]
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
Key: usage.cs,
Language: cs,
Value:
using System.IO;
using MarkdownSnippets;

class Usage
Expand Down Expand Up @@ -43,7 +42,7 @@ class Usage
}
},
Error: ,
FileLocation: https://raw.githubusercontent.com/SimonCropp/MarkdownSnippets/master/src/Tests/Snippets/Usage.cs(1-45),
FileLocation: https://raw.githubusercontent.com/SimonCropp/MarkdownSnippets/master/src/Tests/Snippets/Usage.cs(1-44),
IsInError: false
},
{
Expand All @@ -54,7 +53,7 @@ var files = Directory.EnumerateFiles(@"C:\path", "*.cs", SearchOption.AllDirecto

var snippets = FileSnippetExtractor.Read(files);,
Error: ,
FileLocation: https://raw.githubusercontent.com/SimonCropp/MarkdownSnippets/master/src/Tests/Snippets/Usage.cs(8-14),
FileLocation: https://raw.githubusercontent.com/SimonCropp/MarkdownSnippets/master/src/Tests/Snippets/Usage.cs(7-13),
IsInError: false
},
{
Expand All @@ -68,7 +67,7 @@ DirectoryMarkdownProcessor processor = new(
snippetDirectoryIncludes: _ => true);
processor.Run();,
Error: ,
FileLocation: https://raw.githubusercontent.com/SimonCropp/MarkdownSnippets/master/src/Tests/Snippets/Usage.cs(19-28),
FileLocation: https://raw.githubusercontent.com/SimonCropp/MarkdownSnippets/master/src/Tests/Snippets/Usage.cs(18-27),
IsInError: false
},
{
Expand All @@ -83,7 +82,7 @@ DirectoryMarkdownProcessor processor = new(
snippetDirectoryIncludes: _ => true);
processor.Run();,
Error: ,
FileLocation: https://raw.githubusercontent.com/SimonCropp/MarkdownSnippets/master/src/Tests/Snippets/Usage.cs(33-43),
FileLocation: https://raw.githubusercontent.com/SimonCropp/MarkdownSnippets/master/src/Tests/Snippets/Usage.cs(32-42),
IsInError: false
}
]

0 comments on commit b20ebb5

Please sign in to comment.