From f6364c70d33cb8ce456d4bdd79b2bdf1f0031c00 Mon Sep 17 00:00:00 2001 From: "Diogo Franco (Kovensky)" Date: Tue, 16 Jul 2013 14:06:32 -0300 Subject: [PATCH] anidb: Update documentation / comments --- anidb.go | 3 +++ episodecache.go | 6 ++++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/anidb.go b/anidb.go index 491f667..ee0e0c9 100644 --- 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. diff --git a/episodecache.go b/episodecache.go index cd2e4aa..32fb01d 100644 --- a/episodecache.go +++ b/episodecache.go @@ -72,8 +72,10 @@ func (adb *AniDB) EpisodeByID(eid EID) <-chan *Episode { } go func() { - // The UDP API data is worse than the HTTP API anime data, - // try and get from the corresponding Anime + // The UDP API data is worse than the HTTP API anime data and + // might even get truncated on some pathological cases; + // try and get from the corresponding Anime, which uses the HTTP + // API episode list. aid := AID(0) ok := cache.Get(&aid, "aid", "by-eid", eid) == nil -- 2.44.0