From 3125197dbdc9e080492bd34b56493ef8baa0ab8a Mon Sep 17 00:00:00 2001 From: Chris Beer Date: Tue, 15 Feb 2022 12:42:46 -0800 Subject: [PATCH] Fix the rdocs for the arguments received by the filter_query_builder proc --- lib/blacklight/configuration/facet_field.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/blacklight/configuration/facet_field.rb b/lib/blacklight/configuration/facet_field.rb index 9675456377..20e8220747 100644 --- a/lib/blacklight/configuration/facet_field.rb +++ b/lib/blacklight/configuration/facet_field.rb @@ -45,7 +45,7 @@ class Configuration::FacetField < Blacklight::Configuration::Field # @!attribute pivot # @return [] # @!attribute filter_query_builder - # @return [nil, #call] a Proc (or other object responding to #call) that receives as parameters: 1) the search builder, 2) this facet config + # @return [nil, #call] a Proc (or other object responding to #call) that receives as parameters: 1) the search builder, 2) the Blacklight::FilterField instance # and 3) the solr parameters hash. The Proc returns a string suitable for e.g. Solr's fq parameter, or a 2-element array of the string and a hash of additional # parameters to include with the query (i.e. for referenced subqueries); note that implementations are responsible for ensuring # the additional parameter keys are unique.