[Enhancement] Documented the functions, rewrote embedSimple

naseif · Sep 30, 2021 · 6992809 · 6992809
1 parent 996f402
commit 6992809
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 10 deletions.
diff --git a/modules/commandsReadMe.js b/modules/commandsReadMe.js
@@ -1,7 +1,12 @@
 const mdtable = require("mdtable");
-const {  writeFileSync } = require("fs");
-module.exports.commandsReadMe = (commands) => {
+const { writeFileSync } = require("fs");
+
+/**
+ *
+ * @param {array} commands
+ */
 
+module.exports.commandsReadMe = (commands) => {
   const tableData = {
     header: ["Name", "Description"],
     alignment: ["L", "C"],
@@ -12,11 +17,14 @@ module.exports.commandsReadMe = (commands) => {
     padding: 1,
   };
 
-  commands.map(command => {
-    tableData.rows.push([`**/${command.data.name}**`, command.data.description])
-  })
+  commands.map((command) => {
+    tableData.rows.push([
+      `**/${command.data.name}**`,
+      command.data.description,
+    ]);
+  });
 
-  const commandsTable = mdtable(tableData, tableSettings)
+  const commandsTable = mdtable(tableData, tableSettings);
 
   writeFileSync("./Commands.md", commandsTable, "utf-8");
 };
diff --git a/modules/embedSimple.js b/modules/embedSimple.js
@@ -1,10 +1,15 @@
-function embedMessage(color, description) {
+/**
+ *
+ * @param {string} color
+ * @param {string} description
+ * @returns
+ */
+
+module.exports.embedMessage = (color, description) => {
   const embed = {
     color: color,
     description: description,
   };
 
   return embed;
-}
-
-module.exports = { embedMessage };
+};