From 8e49a73a6311c43cd5ecadf61b479ca2b3dba9e9 Mon Sep 17 00:00:00 2001
From: Matthieu Lalonde <matth@noreply.git.lalonde.me>
Date: Tue, 23 Feb 2021 06:49:39 +0000
Subject: [PATCH] Additional package comments.

---
 pkg/altvr/altvr.go     | 4 +++-
 pkg/altvr/schemas.go   | 2 +-
 pkg/bot/bot.go         | 3 +++
 pkg/discord/discord.go | 2 ++
 pkg/utils/utils.go     | 1 +
 5 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/pkg/altvr/altvr.go b/pkg/altvr/altvr.go
index 3b4d782..d021f80 100644
--- a/pkg/altvr/altvr.go
+++ b/pkg/altvr/altvr.go
@@ -1,3 +1,5 @@
+// Package altvr contains functions used to
+// interface with the AltspaceVR API
 package altvr
 
 import (
@@ -7,7 +9,7 @@ import (
 	"golang.org/x/net/publicsuffix"
 )
 
-// AltVR Client Type
+// AltVR Is the main ASVR client type
 type AltVR struct {
 	jar               *cookiejar.Jar
 	username          string
diff --git a/pkg/altvr/schemas.go b/pkg/altvr/schemas.go
index 3991260..d3e6fc1 100644
--- a/pkg/altvr/schemas.go
+++ b/pkg/altvr/schemas.go
@@ -186,7 +186,7 @@ func (u *User) GetDisplayName() string {
 
 // Identity json struct
 // https://account.altvr.com/api/users/identity.json
-// DO NOT USE!!
+// DO NOT USE!! Requires Auth Token
 type Identity struct {
 	Users    []User `json:"users"`
 	Settings struct {
diff --git a/pkg/bot/bot.go b/pkg/bot/bot.go
index e09788d..9e65fed 100644
--- a/pkg/bot/bot.go
+++ b/pkg/bot/bot.go
@@ -1,3 +1,6 @@
+// Package bot is the main AltspaceVR Bot
+// It initializes the ASVR Client API, the discord bot
+// and handles all requests from the bot.
 package bot
 
 import (
diff --git a/pkg/discord/discord.go b/pkg/discord/discord.go
index d016547..20456c1 100644
--- a/pkg/discord/discord.go
+++ b/pkg/discord/discord.go
@@ -1,3 +1,5 @@
+// Package discord contains the interface functions
+// to for the discordgo library
 package discord
 
 import (
diff --git a/pkg/utils/utils.go b/pkg/utils/utils.go
index 16679d3..b0eb6d9 100644
--- a/pkg/utils/utils.go
+++ b/pkg/utils/utils.go
@@ -1,3 +1,4 @@
+// Package utils contains various utility functions
 package utils
 
 import (