chore: annotate methods in accordance with JSDoc conventions

Author: jamesgeorge007

index.js

@@ -6,10 +6,24 @@ const { Toolkit } = require("actions-toolkit");
 
 const MAX_LINES = 5;
 
+/**
+ * Returns the sentence case representation
+ * @param {String} str - the string
+ *
+ * @returns {String}
+ */
+
 const capitalize = (str) => str.slice(0, 1).toUpperCase() + str.slice(1);
 
 const urlPrefix = "https://github.com/";
 
+/**
+ * Returns a URL in markdown format for PR's and issues
+ * @param {Object | String} item - holds information concerning the issue/PR
+ *
+ * @returns {String}
+ */
+
 const toUrlFormat = (item) => {
   if (typeof item === "object") {
     return Object.hasOwnProperty.call(item.payload, "issue")
@@ -19,6 +33,14 @@ const toUrlFormat = (item) => {
   return `[${item}](${urlPrefix}/${item})`;
 };
 
+/**
+ * Execute shell command
+ * @param {String} cmd - root command
+ * @param {String[]} args - args to be passed alongwith
+ *
+ * @returns {Promise<void>}
+ */
+
 const exec = (cmd, args = []) =>
   new Promise((resolve, reject) => {
     const app = spawn(cmd, args, { stdio: "inherit" });
@@ -33,6 +55,12 @@ const exec = (cmd, args = []) =>
     app.on("error", reject);
   });
 
+/**
+ * Make a commit
+ *
+ * @returns {Promise<void>}
+ */
+
 const commitFile = async () => {
   await exec("git", [
     "config",
@@ -129,6 +157,7 @@ Toolkit.run(
 
     startIdx++;
 
+    // it is likely that a newline is inserted after the <!--START_SECTION:activity--> comment (code formatter)
     let count = 0;
     readmeContent.slice(startIdx, endIdx).forEach((line, idx) => {
       if (line !== "") {