misc: Make the iterator part of EpisodeContainer interface

[go-anidb.git] / anidb.go

diff --git a/anidb.go b/anidb.go
index 491f667f4b96798781ee5c48dd90dd45a5f1ff65..ee0e0c98dd85c6fb47f262ed0909fd8cfb9a1e78 100644 (file)
--- a/anidb.go
+++ b/anidb.go
@@ -11,6 +11,9 @@ import (
 // from the cache. If the sought object isn't cached, or if the cache is
 // stale, then the appropriate API is queried.
 //
+// Queries return their results using channels. Most queries only have one result,
+// but some have 0 or more. All result channels are closed after sending their data.
+//
 // 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.