Improve documentation

cmd/params.go

@@ -45,6 +45,7 @@ func InitParams(vip *viper.Viper) params.General {
 		jww.FATAL.Fatalf("Failed to read session path: %+v", err)
 	}
 
+	// Load banned user CSV
 	bannedUserList, err := utils.ReadFile(viper.GetString("bannedUserList"))
 	if err != nil {
 		jww.WARN.Printf("Failed to read banned user list: %v", err)

cmd/root.go

@@ -44,6 +44,7 @@ var rootCmd = &cobra.Command{
 		initLog()
 		p := InitParams(viper.GetViper())
 
+		// Process CSV into a map
 		bannedUsers := make(map[string]struct{})
 		if p.BannedUserList != "" {
 			bannedUserList := strings.Split(p.BannedUserList, ",")
@@ -52,6 +53,7 @@ var rootCmd = &cobra.Command{
 			}
 		}
 
+		// Initialize storage
 		storage, err := storage.NewStorage(p.DbUsername, p.DbPassword, p.DbName, p.DbAddress, p.DbPort, bannedUsers)
 		if err != nil {
 			jww.FATAL.Panicf("Failed to initialize storage interface: %+v", err)

storage/storage.go

@@ -32,11 +32,14 @@ func NewStorage(username, password, dbName, address, port string, bannedUserList
 	return storage, err
 }
 
+// IsBanned checks if the username is in Storage's bannedUserList.
 func (s *Storage) IsBanned(username string) bool {
 	_, exists := s.bannedUserList[username]
 	return exists
 }
 
+// SetBanned is a testing only helper function which sets a username
+// in Storage's bannedUserList.
 func (s *Storage) SetBanned(username string, t *testing.T) {
 	if t == nil {
 		jww.FATAL.Panic("Cannot use this outside of testing")