Added comments [skip ci]

Andrew Kane
1 parent e112b2a1
Showing 1 changed file with 6 additions and 3 deletions Show diff stats
lib/searchkick/index.rb
@@ -209,6 +209,8 @@ module Searchkick
  
     # reindex
  
+    # note: this is designed to be used internally
+    # so it does not check object matches index class
     def reindex(object, method_name: nil, full: false, **options)
       if object.is_a?(Array)
         # note: purposefully skip full
@@ -254,8 +256,7 @@ module Searchkick
       relation_indexer.batches_left
     end
  
-    # other
-
+    # private
     def klass_document_type(klass, ignore_type = false)
       @klass_document_type[[klass, ignore_type]] ||= begin
         if !ignore_type && klass.searchkick_klass.searchkick_options[:_type]
@@ -268,7 +269,7 @@ module Searchkick
       end
     end
  
-    # should not be public
+    # private
     def conversions_fields
       @conversions_fields ||= begin
         conversions = Array(options[:conversions])
@@ -276,10 +277,12 @@ module Searchkick
       end
     end
  
+    # private
     def suggest_fields
       @suggest_fields ||= Array(options[:suggest]).map(&:to_s)
     end
  
+    # private
     def locations_fields
       @locations_fields ||= begin
         locations = Array(options[:locations])
...	...	@@ -209,6 +209,8 @@ module Searchkick
209	209
210	210	# reindex
211	211
	212	+ # note: this is designed to be used internally
	213	+ # so it does not check object matches index class
212	214	def reindex(object, method_name: nil, full: false, **options)
213	215	if object.is_a?(Array)
214	216	# note: purposefully skip full
...	...	@@ -254,8 +256,7 @@ module Searchkick
254	256	relation_indexer.batches_left
255	257	end
256	258
257		- # other
258		-
	259	+ # private
259	260	def klass_document_type(klass, ignore_type = false)
260	261	@klass_document_type[[klass, ignore_type]] \|\|= begin
261	262	if !ignore_type && klass.searchkick_klass.searchkick_options[:_type]
...	...	@@ -268,7 +269,7 @@ module Searchkick
268	269	end
269	270	end
270	271
271		- # should not be public
	272	+ # private
272	273	def conversions_fields
273	274	@conversions_fields \|\|= begin
274	275	conversions = Array(options[:conversions])
...	...	@@ -276,10 +277,12 @@ module Searchkick
276	277	end
277	278	end
278	279
	280	+ # private
279	281	def suggest_fields
280	282	@suggest_fields \|\|= Array(options[:suggest]).map(&:to_s)
281	283	end
282	284
	285	+ # private
283	286	def locations_fields
284	287	@locations_fields \|\|= begin
285	288	locations = Array(options[:locations])
...	...