Commit 739efa8b authored by Robert Knight's avatar Robert Knight

Remove some comments that are liable to get out of date

Avoid having too many comments about how the UI works in non-UI code.
parent 38f90299
/**
* Tools for applying search filters against annotations.
*
* When the user enters a query in the search box, the query is parsed using
* `generateFacetedFilter` and the currently loaded annotations are then matched
* against the parsed query by the `filter` method of this class. Annotations
* which do not match the filter are then hidden.
*/
/** /**
* @typedef {import('../../types/api').Annotation} Annotation * @typedef {import('../../types/api').Annotation} Annotation
* @typedef {import('../util/search-filter').Facet} Facet * @typedef {import('../util/search-filter').Facet} Facet
...@@ -145,10 +136,10 @@ const fieldMatchers = { ...@@ -145,10 +136,10 @@ const fieldMatchers = {
}; };
/** /**
* Filters a set of annotations. * Filter a set of annotations against a parsed query.
* *
* @param {Annotation[]} annotations * @param {Annotation[]} annotations
* @param {Record<string, Facet>} filters - Faceted filter generated by `generateFacetedFilter` * @param {Record<string, Facet>} filters
* @return {string[]} IDs of matching annotations. * @return {string[]} IDs of matching annotations.
*/ */
export function filterAnnotations(annotations, filters) { export function filterAnnotations(annotations, filters) {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment