chore: use Markdown formatting in names (#48)

* Changes to use markdown formating.

* Update src/Maths/Abs.sol

Co-authored-by: David Leal <[email protected]>

* Update src/Maths/AliquotSum.sol

Co-authored-by: David Leal <[email protected]>

* incorporating review suggestions.

* Changes to incorporate review comments.

Co-authored-by: Max Kubik <[email protected]>
Co-authored-by: David Leal <[email protected]>

Author: 3 people

src/Maths/Abs.sol

@@ -1,18 +1,18 @@
-// SPDX-License-Identifier: MIT
-pragma solidity ^0.8.0;
-
-/**
- * @title Get the absolute value of an integer.
- * @author Perelyn https://github.com/Perelyn-sama
- * @dev https://www.khanacademy.org/math/cc-sixth-grade-math/cc-6th-negative-number-topic/cc-6th-absolute-value/v/absolute-value-of-integers
- */
-contract Abs {
-    /// Pass in a number and get it's absolute value
-    function getAbs(int256 _n) public pure returns (int256 result) {
-        if (_n < 0) {
-            result = -(_n);
-        } else {
-            result = _n;
-        }
-    }
-}
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+/**
+ * @title Get the absolute value of an integer.
+ * @author [Perelyn](https://github.com/Perelyn-sama)
+ * @dev https://www.khanacademy.org/math/cc-sixth-grade-math/cc-6th-negative-number-topic/cc-6th-absolute-value/v/absolute-value-of-integers
+ */
+contract Abs {
+    /// Pass in a number and get it's absolute value
+    function getAbs(int256 _n) public pure returns (int256 result) {
+        if (_n < 0) {
+            result = -(_n);
+        } else {
+            result = _n;
+        }
+    }
+}

src/Maths/AddArray.sol

@@ -1,30 +1,30 @@
-// SPDX-License-Identifier: MIT
-pragma solidity ^0.8.0;
-
-/**
- * @title Array Addition.
- * @author Anthony (fps) https://github.com/fps8k.
- * @dev Contract to demonstrate how an array is added.
- */
-
-contract AddArray {
-    /**
-     * @dev Takes in an array of numbers and adds them and returns the cumultative total.
-     * @param _arr array of numbers
-     * @return total => sum of array.
-     */
-    function addArr(uint256[] memory _arr) public pure returns (uint256 total) {
-        /// @dev Initialize the total we need to return to 0.
-        uint256 sum = 0;
-
-        /// @dev Loop through the array.
-        for (uint256 i = 0; i < _arr.length; i++) {
-            /// @dev On every element, add the value of the element to the current sum.
-            /// @dev For sums > the maximum uint value, solidity versions > 0.8.0 will revert on overflow.
-            sum += _arr[i];
-        }
-
-        /// @dev Return the total.
-        total = sum;
-    }
-}
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+/**
+ * @title Array Addition.
+ * @author [Anthony (fps)](https://github.com/fps8k)
+ * @dev Contract to demonstrate how an array is added.
+ */
+
+contract AddArray {
+    /**
+     * @dev Takes in an array of numbers and adds them and returns the cumultative total.
+     * @param _arr array of numbers
+     * @return total => sum of array.
+     */
+    function addArr(uint256[] memory _arr) public pure returns (uint256 total) {
+        /// @dev Initialize the total we need to return to 0.
+        uint256 sum = 0;
+
+        /// @dev Loop through the array.
+        for (uint256 i = 0; i < _arr.length; i++) {
+            /// @dev On every element, add the value of the element to the current sum.
+            /// @dev For sums > the maximum uint value, solidity versions > 0.8.0 will revert on overflow.
+            sum += _arr[i];
+        }
+
+        /// @dev Return the total.
+        total = sum;
+    }
+}

src/Maths/AliquotSum.sol

@@ -1,16 +1,16 @@
-// SPDX-License-Identifier: MIT
-pragma solidity ^0.8.0;
-
-/**
- * @title Get the absoule value of an integer.
- * @author Perelyn https://github.com/Perelyn-sama
- */
-contract AliquotSum {
-    /// Get the Aliquote sum of a positive integer
-    function getAliquotSum(uint256 _n) public pure returns (uint256 result) {
-        for (uint256 i = 1; i < _n - 1; i++) {
-            _n % i == 0 ? result += i : i;
-        }
-        return result;
-    }
-}
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+/**
+ * @title Get the absoule value of an integer.
+ * @author [Perelyn](https://github.com/Perelyn-sama)
+ */
+contract AliquotSum {
+    /// Get the Aliquote sum of a positive integer
+    function getAliquotSum(uint256 _n) public pure returns (uint256 result) {
+        for (uint256 i = 1; i < _n - 1; i++) {
+            _n % i == 0 ? result += i : i;
+        }
+        return result;
+    }
+}