Skip to content

Commit

Permalink
Doco changes
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Sep 20, 2023
1 parent 662014c commit 213ca5c
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ Creates a new empty file
```cs
AllFiles.CreateFile(pathOfFileToCreate);
```
<sup><a href='/src/Tests/Tests.cs#L135-L139' title='Snippet source file'>snippet source</a> | <a href='#snippet-createfile' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Tests.cs#L133-L137' title='Snippet source file'>snippet source</a> | <a href='#snippet-createfile' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

Throws an exception if the extension is not known. There is also a `TryCreateFile` that will return false if the extension is not known.
Expand All @@ -169,7 +169,7 @@ Gets the path to an empty file for a given extension
```cs
var path = AllFiles.GetPathFor("jpg");
```
<sup><a href='/src/Tests/Tests.cs#L116-L120' title='Snippet source file'>snippet source</a> | <a href='#snippet-getpathfor' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Tests.cs#L114-L118' title='Snippet source file'>snippet source</a> | <a href='#snippet-getpathfor' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

Throws an exception if the extension is not known. There is also a `TryGetPathFor` that will return false if the extension is not known.
Expand All @@ -187,7 +187,7 @@ Assert.True(AllFiles.IsEmptyFile(path));
var temp = Path.GetTempFileName();
Assert.False(AllFiles.IsEmptyFile(temp));
```
<sup><a href='/src/Tests/Tests.cs#L164-L171' title='Snippet source file'>snippet source</a> | <a href='#snippet-isemptyfile' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Tests.cs#L162-L169' title='Snippet source file'>snippet source</a> | <a href='#snippet-isemptyfile' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->


Expand All @@ -203,7 +203,7 @@ foreach (var path in AllFiles.AllPaths)
Trace.WriteLine(path);
}
```
<sup><a href='/src/Tests/Tests.cs#L192-L199' title='Snippet source file'>snippet source</a> | <a href='#snippet-allpaths' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Tests.cs#L190-L197' title='Snippet source file'>snippet source</a> | <a href='#snippet-allpaths' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->


Expand All @@ -217,7 +217,7 @@ Use or replace a file
AllFiles.UseFile(Category.Document, pathToFile);
Assert.IsTrue(AllFiles.DocumentPaths.Contains(pathToFile));
```
<sup><a href='/src/Tests/Tests.cs#L210-L215' title='Snippet source file'>snippet source</a> | <a href='#snippet-usefile' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/Tests.cs#L208-L213' title='Snippet source file'>snippet source</a> | <a href='#snippet-usefile' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->


Expand All @@ -238,7 +238,7 @@ Assert.False(FileExtensions.IsText(".bin"));
Assert.True(FileExtensions.IsText("txt"));
Assert.False(FileExtensions.IsText("bin"));
```
<sup><a href='/src/Tests/ExtensionsTests.cs#L8-L17' title='Snippet source file'>snippet source</a> | <a href='#snippet-istext' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/ExtensionsTests.cs#L6-L15' title='Snippet source file'>snippet source</a> | <a href='#snippet-istext' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->


Expand All @@ -252,7 +252,7 @@ FileExtensions.AddTextExtension(".ext2");
Assert.True(FileExtensions.IsText("ext1"));
Assert.True(FileExtensions.IsText("ext2"));
```
<sup><a href='/src/Tests/ExtensionsTests.cs#L23-L30' title='Snippet source file'>snippet source</a> | <a href='#snippet-addtextextension' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/ExtensionsTests.cs#L21-L28' title='Snippet source file'>snippet source</a> | <a href='#snippet-addtextextension' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->


Expand All @@ -270,7 +270,7 @@ FileExtensions.RemoveTextExtension(".ext2");
Assert.False(FileExtensions.IsText("ext1"));
Assert.False(FileExtensions.IsText("ext2"));
```
<sup><a href='/src/Tests/ExtensionsTests.cs#L36-L47' title='Snippet source file'>snippet source</a> | <a href='#snippet-removetextextension' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Tests/ExtensionsTests.cs#L34-L45' title='Snippet source file'>snippet source</a> | <a href='#snippet-removetextextension' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->


Expand Down

0 comments on commit 213ca5c

Please sign in to comment.