feat(GuildPreview.IconURL): add docs for size

Add documentation comment for size parameter of GuildPreview.IconURL function.
bwmarrin · Jan 17, 2023 · d583fd1 · d583fd1
1 parent cb59c78
commit d583fd1
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/structs.go b/structs.go
@@ -916,6 +916,9 @@ type GuildPreview struct {
 }
 
 // IconURL returns a URL to the guild's icon.
+//
+//	size:    The size of the desired icon image as a power of two
+//	         Image size can be any power of two between 16 and 4096.
 func (g *GuildPreview) IconURL(size string) string {
 	return iconURL(g.Icon, EndpointGuildIcon(g.ID, g.Icon), EndpointGuildIconAnimated(g.ID, g.Icon), size)
 }