Skip to content

Commit

Permalink
Merge pull request #1948 from projectblacklight/add_docs
Browse files Browse the repository at this point in the history
Add class documentation
  • Loading branch information
mejackreed committed Jul 23, 2018
2 parents c912b88 + 0089b16 commit 57f99fb
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions lib/blacklight/configuration/context.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
# frozen_string_literal: true

module Blacklight
class Configuration
# This class helps determine whether a specific field/tool should display for a
# particular controller. This is used when the field/tool is configured with an
# _if_ or _unless_ argument.
#
# e.g.
# config.add_results_document_tool(:bookmark,
# partial: 'bookmark_control',
# if: :render_bookmarks_control?)
#
# The context points at the scope for where to evaluate the method _render_bookmarks_control?_
class Context
attr_reader :context

Expand Down

0 comments on commit 57f99fb

Please sign in to comment.