[ci skip] Add doc for preloader_for

This commit is contained in:
schneems 2015-10-26 14:20:39 -05:00
parent d81fbe22ed
commit 6a25202d9e

@ -186,6 +186,10 @@ def self.run(preloader); end
def self.preloaded_records; []; end
end
# Returns a class containing the logic needed to load preload the data
# and attach it to a relation. For example +Preloader::Association+ or
# +Preloader::HasManyThrough+. The class returned implements a `run` method
# that accepts a preloader.
def preloader_for(reflection, owners, rhs_klass)
return NullPreloader unless rhs_klass