Skip to content

Commit

Permalink
Document how the Searchable module works
Browse files Browse the repository at this point in the history
  • Loading branch information
jcoyne authored and cbeer committed Sep 27, 2020
1 parent 95afa3d commit beeefcd
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions app/controllers/concerns/blacklight/searchable.rb
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
# frozen_string_literal: true

# The Searchable module can be included onto classes that need to initialize a SearchService.
# There are three dependencies you must provide on the including class. Typically these
# would be provided by Blacklight::Controller
# 1. search_state
# 2. blacklight_config
# 3. search_service_class
#
# Additionally, the including class may override the search_service_context method to provide
# further context to the SearchService. For example you could override this to provide the
# currently signed in user.
module Blacklight::Searchable
# @return [Blacklight::SearchService]
def search_service
Expand Down

0 comments on commit beeefcd

Please sign in to comment.