Add comments to test methods.

TheSquidCombatant · Oct 16, 2023 · 4fe9e78 · 4fe9e78
1 parent 5e28f5d
commit 4fe9e78
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/TheSquid.Numerics.Extensions.Tests/NextBigIntegerExtensionTests.cs b/TheSquid.Numerics.Extensions.Tests/NextBigIntegerExtensionTests.cs
@@ -8,6 +8,9 @@ namespace TheSquid.Numerics.Extensions.Tests
     [TestClass]
     public class NextBigIntegerExtensionTests
     {
+        /// <summary>
+        /// Checks that all generated values are within the specified range.
+        /// </summary>
         [TestMethod]
         [DataRow(100, 10000)]
         [DataRow(1000, 1000)]

diff --git a/TheSquid.Numerics.Extensions.Tests/NthRootExtensionTests.cs b/TheSquid.Numerics.Extensions.Tests/NthRootExtensionTests.cs
@@ -9,6 +9,9 @@ namespace TheSquid.Numerics.Extensions.Tests
     [TestClass]
     public class NthRootExtensionTests
     {
+        /// <summary>
+        /// Checks that any value obtained when extracting the root coincides with the value previously raised to a power.
+        /// </summary>
         [TestMethod]
         [DataRow(10000, 1000, 1000)]
         [DataRow(10000, 10000, 100)]

diff --git a/TheSquid.Numerics.Extensions.Tests/PowCachedExtensionTests.cs b/TheSquid.Numerics.Extensions.Tests/PowCachedExtensionTests.cs
@@ -8,6 +8,9 @@ namespace TheSquid.Numerics.Extensions.Tests
     [TestClass]
     public class PowCachedExtensionTests
     {
+        /// <summary>
+        /// Checks that any value calculated using caching exponentiation matches the value calculated by the standard method.
+        /// </summary>
         [TestMethod]
         [DataRow(10000, 100, 100)]
         [DataRow(100000, 100, 100)]