anidb: Document which backend API is used on the Get* methods

[go-anidb.git] / episodecache.go

diff --git a/episodecache.go b/episodecache.go
index 00b2a405ec22243287504dd4a1bfa195bb79384d..4d8fa7e87aca36ea2a3ec6c37f9525cc46fcfe90 100644 (file)
--- a/episodecache.go
+++ b/episodecache.go
@@ -40,6 +40,10 @@ func cacheEpisode(ep *Episode) {
 }
 
 // Retrieves an Episode by its EID.
+//
+// If we know which AID owns this EID, then it's equivalent
+// to an Anime query. Otherwise, uses both the HTTP and UDP
+// APIs to retrieve it.
 func (adb *AniDB) EpisodeByID(eid EID) <-chan *Episode {
        keys := []cacheKey{"eid", eid}
        ch := make(chan *Episode, 1)