Added lots of comments and documentation 📘

lua/gitlab/job.lua

@@ -2,6 +2,8 @@ local Job   = require("plenary.job")
 local state = require("gitlab.state")
 local M     = {}
 
+-- This function is responsible for making API calls to the Go server and
+-- running the callbacks associated with those jobs when the JSON is returned
 M.run_job   = function(endpoint, method, body, callback)
   local args = { "-s", "-X", (method or "POST"), string.format("localhost:%s/", state.PORT) .. endpoint }