Update TwinPrime.js

Exortions · web-flow · commit 44d2b33f2794 · 2022-05-26T15:06:47.000-07:00
diff --git a/Maths/TwinPrime.js b/Maths/TwinPrime.js
@@ -13,6 +13,14 @@ function isPrime (n) {
   return !prime
 }
 
+/**
+ * @function twinPrime
+ * Gets the 'twin prime' of a prime number.
+ * @returns {Array} Either an array with the original [0], and the twin [1], or an empty array if one of the numbers are not prime.
+ * @see https://en.wikipedia.org/wiki/Twin_prime
+ * @example twinPrime(5) = [5, 7]
+ * @example twinPrime(4) = []
+*/
 function twinPrime (n) {
   const result = []
   const prime = isPrime(n)
