add description to Entitlement struct & type

jhoffi · Aug 2, 2024 · 84ecf01 · 84ecf01
1 parent 4bbe559
commit 84ecf01
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/entitlement.go b/entitlement.go
@@ -1,10 +1,10 @@
 package discordgo
 
-// The type of entitlement
+// EntitlementType is the type of entitlement (see EntitlementType* consts)
+// https://discord.com/developers/docs/monetization/entitlements#entitlement-object-entitlement-types
 type EntitlementType int
 
 // Valid EntitlementType values
-// https://discord.com/developers/docs/monetization/entitlements#entitlement-object-entitlement-types
 const (
 	EntitlementTypePurchase = 1
 	EntitlementTypePremiumSubscription = 2
@@ -16,6 +16,8 @@ const (
 	EntitlementTypeApplicationSubscription = 8
 )
 
+// Entitlements represent that a user or guild has access to a premium offering
+// in your application.
 type Entitlement struct {
 	// The ID of the entitlement
 	ID string `json:"id"`