search: adapter docs #409

McShelby · Oct 25, 2024 · bb9790f · bb9790f
1 parent c84ba71
commit bb9790f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/layouts/partials/version.txt b/layouts/partials/version.txt
@@ -1 +1 @@
-7.1.1+2574cb83408f0b6052262980adb20f291c16edd8
+7.1.1+c84ba71c2c388858d47ea183a7df3fda7f2c27b3
diff --git a/static/js/lunr-adapter.js b/static/js/lunr-adapter.js
@@ -10,7 +10,7 @@ Initialize the search engine and the search index
 
 ### Parameters
 
-one
+none
 
 ### Returns
 
@@ -27,15 +27,15 @@ Once successfully completed, needs to call
 
 ## search()
 
-Performs the search and returs found results
+Performs the search and returs found results.
 
 ### Parameters
 
-**term**: The search term that was typed in by the user
+term: string // the search term that was typed in by the user
 
 ### Returns
 
-Must return an array of found pages, sorted with the most relevant pages first.
+Must return an array of found pages, sorted with the most relevant page first.
 
 Each array item needs the following layout:
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		7.1.1+2574cb83408f0b6052262980adb20f291c16edd8
		7.1.1+c84ba71c2c388858d47ea183a7df3fda7f2c27b3