testing - comments

source/doc.go

@@ -2,7 +2,16 @@
 // CSS, JS, SCSS, HTML and other website related content.
 // This package uses Rice to compile all assets into a single 'rice-box.go' file.
 //
-// To compile all the assets run `rice embed-go` in the source directory.
+// Required Dependencies
+//
+// - rice -> https://github.com/GeertJohan/go.rice
+// - sass -> https://sass-lang.com/install
+//
+// Compile Assets
+//
+// To compile all the HTML, JS, SCSS, CSS and image assets you'll need to have rice and sass installed on your local system.
+//		sass source/scss/base.scss source/css/base.css
+//		cd source && rice embed-go
 //
 // More info on: https://github.com/hunterlong/statup
 package source

types/user.go

@@ -19,6 +19,7 @@ import (
 	"time"
 )
 
+// User is the main struct for Users
 type User struct {
 	Id            int64     `gorm:"primary_key;column:id" json:"id"`
 	Username      string    `gorm:"type:varchar(100);unique;column:username;" json:"username"`
@@ -32,8 +33,8 @@ type User struct {
 	UserInterface `gorm:"-" json:"-"`
 }
 
+// UserInterface interfaces the database functions
 type UserInterface interface {
-	// Database functions
 	Create() (int64, error)
 	Update() error
 	Delete() error

utils/doc.go

@@ -1,7 +1,7 @@
 // Package utils contains common methods used in most packages in Statup.
 // This package contains multiple function like:
 // Logging, encryption, type conversions, setting utils.Directory as the current directory,
-// running local CMD commands, and creaing/deleting files/folder.
+// running local CMD commands, and creating/deleting files/folder.
 //
 // You can overwrite the utils.Directory global variable by including
 // STATUP_DIR environment variable to be an absolute path.