Add example usage to the generated SearchBuilder; fixes #1492

projectblacklight · Sep 15, 2016 · f64b9c2 · f64b9c2
1 parent e596610
commit f64b9c2
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/lib/generators/blacklight/templates/search_builder.rb b/lib/generators/blacklight/templates/search_builder.rb
@@ -1,4 +1,12 @@
 # frozen_string_literal: true
 class SearchBuilder < Blacklight::SearchBuilder
   include Blacklight::Solr::SearchBuilderBehavior
+
+  ##
+  # @example Adding a new step to the processor chain
+  #   self.default_processor_chain += [:add_custom_data_to_query]
+  #
+  #   def add_custom_data_to_query(solr_parameters)
+  #     solr_parameters[:custom] = blacklight_params[:user_value]
+  #   end
 end