anidb: Document that credentials are needed for UDP queries

[go-anidb.git] / anidb.go

diff --git a/anidb.go b/anidb.go
index bfe81d1ce1aa37867d7dbfd4e9da6fb3853c8d96..491f667f4b96798781ee5c48dd90dd45a5f1ff65 100644 (file)
--- a/anidb.go
+++ b/anidb.go
@@ -10,6 +10,10 @@ import (
 // All ObjectByKey methods (AnimeByID, GroupByName, etc) first try to read
 // from the cache. If the sought object isn't cached, or if the cache is
 // stale, then the appropriate API is queried.
+//
+// Queries that depend on the UDP API can't be used without first authenticating
+// to the API server. This uses the credentials stored by SetCredentials, or
+// by a previous Auth() call.
 type AniDB struct {
        Timeout time.Duration // Timeout for the various calls (default: 45s)