update: comments

handlers/deploy.go

@@ -11,8 +11,8 @@ import (
 /*
  * Deploy is a handler for the /deploy endpoint.
 
- * If the request is ping, it returns "pong" message.
- * Else, it pulls and returns "done" message the repo if signature is valid.
+ * If the request is just a ping message, it returns "pong" message. Otherwise,
+ * it pulls the repo and returns "done" message if the signature is valid.
  */
 
 func Deploy(c *gin.Context) {

utils/check.go

@@ -6,7 +6,8 @@ import (
 )
 
 /*
- * Check, checks if the .git directory exists in the specified directory.
+ * Check is a function to check if the ".git/" directory
+ * exists in the given directory.
  */
 
 func Check(dir string) error {

utils/clear.go

@@ -7,7 +7,7 @@ import (
 )
 
 /*
- * Clear, clears the terminal.
+ * Clear is a function for clearing the terminal screen.
  */
 
 func Clear() {

utils/log.go

@@ -7,7 +7,7 @@ import (
 )
 
 /*
- * Log, logs messages to the console.
+ * Log is a function for printing a log message.
  */
 
 func Log(level int, message string, newLine bool) {

utils/pull.go

@@ -6,7 +6,7 @@ import (
 )
 
 /*
- * Pull, pulls the latest changes from the repo.
+ * Pull is a function for executing the "git pull" command.
  */
 
 func Pull(dir string) error {

utils/repository.go

@@ -8,8 +8,8 @@ import (
 )
 
 /*
- * Repository, gets the repository url from the ./git/config
- * file in the specified directory.
+ * Repository is a function to get the repository URL from
+ * the "./git/config" file in the specified directory.
  */
 
 func Repository(dir string) (string, error) {

utils/signature.go

@@ -9,8 +9,8 @@ import (
 )
 
 /*
- * Signature, checks if the request signature matches the
- * signature of the specified values.
+ * Signature is a function for checking if the request signature
+ * matches the signature of the specified values.
  */
 
 func Signature(secret, header, payload string) error {