Update docs (#125)

siriak · web-flow · commit 37de9575e567 · 2019-12-09T21:58:43.000+02:00
* Add docs to solution

* Rename Utility -&gt; Utilities

* Update reference to Utilities

* Remove failing greetings workflow
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,9 +1,5 @@
-# Description
-
 Please include a brief summary of the change. Please also include relevant motivation and context (if applicable).
 
-# Checklist:
-
 - [ ] I have performed a self-review of my own code
 - [ ] My code follows the style guidelines of this project
 - [ ] I have commented my code in hard-to-understand areas
diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml
diff --git a/Algorithms.Tests/Search/LinearSearcherTests.cs b/Algorithms.Tests/Search/LinearSearcherTests.cs
@@ -3,7 +3,7 @@
 using Algorithms.Search;
 using NUnit.Framework;
 using NUnit.Framework.Internal;
-using Utility.Exception;
+using Utilities.Exceptions;
 
 namespace Algorithms.Tests.Search
 {
@@ -51,7 +51,7 @@ public static void Find_ItemMissing_ItemNotFoundExceptionThrown([Random(0, 1_000
 
             // Act
             // Assert
-            _ = Assert.Throws(typeof(ItemNotFoundException), () => searcher.Find(arrayToSearch, x => false));
+            _ = Assert.Throws<ItemNotFoundException>(() => searcher.Find(arrayToSearch, x => false));
         }
 
         [Test]
diff --git a/Algorithms/Algorithms.csproj b/Algorithms/Algorithms.csproj
@@ -24,7 +24,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\Utility\Utility.csproj" />
+    <ProjectReference Include="..\Utilities\Utilities.csproj" />
   </ItemGroup>
 
 </Project>
diff --git a/Algorithms/DataCompression/HuffmanCompressor.cs b/Algorithms/DataCompression/HuffmanCompressor.cs
@@ -2,7 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using Algorithms.Sorters.Comparison;
-using Utility.Extension;
+using Utilities.Extensions;
 
 namespace Algorithms.DataCompression
 {
diff --git a/Algorithms/DataCompression/ShannonFanoCompressor.cs b/Algorithms/DataCompression/ShannonFanoCompressor.cs
@@ -1,7 +1,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using Algorithms.Knapsack;
-using Utility.Extension;
+using Utilities.Extensions;
 
 namespace Algorithms.DataCompression
 {
diff --git a/Algorithms/Search/LinearSearcher.cs b/Algorithms/Search/LinearSearcher.cs
@@ -1,5 +1,5 @@
 using System;
-using Utility.Exception;
+using Utilities.Exceptions;
 
 namespace Algorithms.Search
 {
diff --git a/C-Sharp.sln b/C-Sharp.sln
@@ -3,25 +3,32 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 16
 VisualStudioVersion = 16.0.28803.352
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Algorithms", "Algorithms\Algorithms.csproj", "{EC967159-73D8-4E44-8455-E2D16DB4CBBB}"
-EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DataStructures", "DataStructures\DataStructures.csproj", "{E9C27C73-1F95-4C6E-9DB4-F8585426A850}"
-EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Algorithms.Tests", "Algorithms.Tests\Algorithms.Tests.csproj", "{56817595-1552-409B-93B8-F8082F8490A5}"
-EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DataStructures.Tests", "DataStructures.Tests\DataStructures.Tests.csproj", "{39174100-3A6E-45B2-9AA9-7C69764C0750}"
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docs", "Docs", "{DAB16DEC-AF31-4B59-8DD5-5C76C1A23052}"
+	ProjectSection(SolutionItems) = preProject
+		CODE_OF_CONDUCT.md = CODE_OF_CONDUCT.md
+		CONTRIBUTING.md = CONTRIBUTING.md
+		LICENSE = LICENSE
+		README.md = README.md
+	EndProjectSection
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SolutionItems", "SolutionItems", "{F3AC2246-318B-4EE4-BD9E-D751D3044901}"
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Configs", "Configs", "{F3AC2246-318B-4EE4-BD9E-D751D3044901}"
 	ProjectSection(SolutionItems) = preProject
 		.editorconfig = .editorconfig
 		.gitignore = .gitignore
 		.travis.yml = .travis.yml
-		README.md = README.md
 		stylecop.json = stylecop.json
 		stylecop.ruleset = stylecop.ruleset
 	EndProjectSection
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Utility", "Utility\Utility.csproj", "{3A41157D-296D-4BFC-A34E-91B5ED7F0905}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Algorithms", "Algorithms\Algorithms.csproj", "{EC967159-73D8-4E44-8455-E2D16DB4CBBB}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Algorithms.Tests", "Algorithms.Tests\Algorithms.Tests.csproj", "{56817595-1552-409B-93B8-F8082F8490A5}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DataStructures", "DataStructures\DataStructures.csproj", "{E9C27C73-1F95-4C6E-9DB4-F8585426A850}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DataStructures.Tests", "DataStructures.Tests\DataStructures.Tests.csproj", "{39174100-3A6E-45B2-9AA9-7C69764C0750}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Utilities", "Utilities\Utilities.csproj", "{3A41157D-296D-4BFC-A34E-91B5ED7F0905}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
diff --git a/Utilities/Exceptions/ItemNotFoundException.cs b/Utilities/Exceptions/ItemNotFoundException.cs
@@ -1,6 +1,6 @@
 ﻿using System;
 
-namespace Utility.Exception
+namespace Utilities.Exceptions
 {
     /// <summary>
     /// Signs that sequence doesn't contain any items that one was looking for.
diff --git a/Utilities/Extensions/DictionaryExtensions.cs b/Utilities/Extensions/DictionaryExtensions.cs
@@ -1,8 +1,8 @@
 ﻿using System.Collections.Generic;
 
-namespace Utility.Extension
+namespace Utilities.Extensions
 {
-    public static class DictionaryExtension
+    public static class DictionaryExtensions
     {
         public static void AddMany<TKey, TValue>(this Dictionary<TKey, TValue> keys, IEnumerable<(TKey, TValue)> enumerable)
         {
diff --git a/Utilities/Utilities.csproj b/Utilities/Utilities.csproj

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`using Algorithms.Search;`
`4`	`4`	`using NUnit.Framework;`
`5`	`5`	`using NUnit.Framework.Internal;`
`6`		`-using Utility.Exception;`
	`6`	`+using Utilities.Exceptions;`
`7`	`7`
`8`	`8`	`namespace Algorithms.Tests.Search`
`9`	`9`	`{`
`@@ -51,7 +51,7 @@ public static void Find_ItemMissing_ItemNotFoundExceptionThrown([Random(0, 1_000`
`51`	`51`
`52`	`52`	`// Act`
`53`	`53`	`// Assert`
`54`		`- _ = Assert.Throws(typeof(ItemNotFoundException), () => searcher.Find(arrayToSearch, x => false));`
	`54`	`+ _ = Assert.Throws<ItemNotFoundException>(() => searcher.Find(arrayToSearch, x => false));`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`[Test]`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`using System.Collections.Generic;`
`3`	`3`	`using System.Linq;`
`4`	`4`	`using Algorithms.Sorters.Comparison;`
`5`		`-using Utility.Extension;`
	`5`	`+using Utilities.Extensions;`
`6`	`6`
`7`	`7`	`namespace Algorithms.DataCompression`
`8`	`8`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`using System.Collections.Generic;`
`2`	`2`	`using System.Linq;`
`3`	`3`	`using Algorithms.Knapsack;`
`4`		`-using Utility.Extension;`
	`4`	`+using Utilities.Extensions;`
`5`	`5`
`6`	`6`	`namespace Algorithms.DataCompression`
`7`	`7`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`using System;`
`2`		`-using Utility.Exception;`
	`2`	`+using Utilities.Exceptions;`
`3`	`3`
`4`	`4`	`namespace Algorithms.Search`
`5`	`5`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`using System;`
`2`	`2`
`3`		`-namespace Utility.Exception`
	`3`	`+namespace Utilities.Exceptions`
`4`	`4`	`{`
`5`	`5`	`/// <summary>`
`6`	`6`	`/// Signs that sequence doesn't contain any items that one was looking for.`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`	`1`	`using System.Collections.Generic;`
`2`	`2`
`3`		`-namespace Utility.Extension`
	`3`	`+namespace Utilities.Extensions`
`4`	`4`	`{`
`5`		`- public static class DictionaryExtension`
	`5`	`+ public static class DictionaryExtensions`
`6`	`6`	`{`
`7`	`7`	`public static void AddMany<TKey, TValue>(this Dictionary<TKey, TValue> keys, IEnumerable<(TKey, TValue)> enumerable)`
`8`	`8`	`{`