added jsdoc comment for divide.js

DanielJDufour · Nov 23, 2022 · 4b7346a · 4b7346a
1 parent 13c31d8
commit 4b7346a
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/divide.js b/divide.js
@@ -4,6 +4,15 @@ const absolute = require("./absolute.js");
 const clean = require("./clean.js");
 const long_division = require("./long_division.js");
 
+/**
+ * @name divide
+ * @param {String} dividend
+ * @param {String} divisor
+ * @param {Object} options
+ * @param {Number} options.max_decimal_digits
+ * @param {Boolean} options.ellipsis
+ * @returns {String} - quotient
+ */
 function divide(dividend, divisor, options) {
   dividend = clean(dividend);
   divisor = clean(divisor);