Update some comments for variables

tmaffia · Aug 13, 2024 · bc262b2 · bc262b2
1 parent 3f7910c
commit bc262b2
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 42 deletions.
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ Wrapper for the raider.io API written in Go
 
 ### Include module in your go.mod 
 ```
-include github.com/tmaffia/raiderio v0.3.2
+include github.com/tmaffia/raiderio v0.3.3
 ```
 
 ### Get a Character Profile

diff --git a/errors.go b/errors.go
@@ -5,6 +5,7 @@ import (
 	"strings"
 )
 
+// Errors that the api produces
 var (
 	ErrInvalidRegion     = errors.New("invalid region")
 	ErrInvalidRealm      = errors.New("invalid realm")

diff --git a/raid.go b/raid.go
@@ -134,6 +134,7 @@ type Encounter struct {
 // Options are "normal", "heroic", and "mythic"
 type RaidDifficulty string
 
+// Options for different difficulties for raid and dugneon queries
 var Difficulty = struct {
 	NormalRaid RaidDifficulty
 	HeroicRaid RaidDifficulty

diff --git a/region.go b/region.go
@@ -7,44 +7,43 @@ type Region struct {
 	ShortName string `json:"short_name"`
 }
 
-var (
-	Regions = struct {
-		WORLD *Region
-		US    *Region
-		EU    *Region
-		KR    *Region
-		TW    *Region
-		CN    *Region
-	}{
-		WORLD: &Region{
-			Name:      "World",
-			Slug:      "world",
-			ShortName: "world",
-		},
-		US: &Region{
-			Name:      "US",
-			Slug:      "us",
-			ShortName: "us",
-		},
-		EU: &Region{
-			Name:      "EU",
-			Slug:      "eu",
-			ShortName: "eu",
-		},
-		KR: &Region{
-			Name:      "KR",
-			Slug:      "kr",
-			ShortName: "kr",
-		},
-		TW: &Region{
-			Name:      "TW",
-			Slug:      "tw",
-			ShortName: "tw",
-		},
-		CN: &Region{
-			Name:      "CN",
-			Slug:      "cn",
-			ShortName: "cn",
-		},
-	}
-)
+// List of regions which can be used in queries in the library
+var Regions = struct {
+	WORLD *Region
+	US    *Region
+	EU    *Region
+	KR    *Region
+	TW    *Region
+	CN    *Region
+}{
+	WORLD: &Region{
+		Name:      "World",
+		Slug:      "world",
+		ShortName: "world",
+	},
+	US: &Region{
+		Name:      "US",
+		Slug:      "us",
+		ShortName: "us",
+	},
+	EU: &Region{
+		Name:      "EU",
+		Slug:      "eu",
+		ShortName: "eu",
+	},
+	KR: &Region{
+		Name:      "KR",
+		Slug:      "kr",
+		ShortName: "kr",
+	},
+	TW: &Region{
+		Name:      "TW",
+		Slug:      "tw",
+		ShortName: "tw",
+	},
+	CN: &Region{
+		Name:      "CN",
+		Slug:      "cn",
+		ShortName: "cn",
+	},
+}