Skip to content

Commit e0f65cb

Browse files
committed
Fixup PrimoSearch documentation
1 parent 6cb6a51 commit e0f65cb

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

app/models/primo_search.rb

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Searches Primo Search API and formats results
22
#
33
class PrimoSearch
4-
# Initializes the PrimoSearch with the given query parameters
4+
# Initializes PrimoSearch
55
# @param tab [String] Current `active_tab` value from SearchController. Used to set Primo tab/scope.
66
# Defaults to 'all'.
77
# @return [PrimoSearch] An instance of PrimoSearch
@@ -85,11 +85,12 @@ def primo_scope
8585
# all: scopes(all, all_filtered, catalog, cdi, CourseReserves)
8686
# bento: scopes(cdi, catalog, bento_catalog, all_use)
8787
# USE: scopes(all_use, all, catalog_use, cdi_use)
88+
# This application should always use the 'use' tab for Primo searches.
8889
def primo_tab
8990
'use'
9091
end
9192

92-
# In Primo API, a vid is...[documentaiton needed!]
93+
# In Primo API, a view (vid) contains Search Profile Slots (tabs) which in turn contain Search Profiles (scopes).
9394
def primo_vid
9495
ENV.fetch('PRIMO_VID', nil)
9596
end

0 commit comments

Comments
 (0)