feat: jsdoc (#287)

DataBiosphere · Dec 4, 2024 · ed66693 · ed66693
1 parent 118e9ff
commit ed66693
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/providers/fileManifestState/utils.ts b/src/providers/fileManifestState/utils.ts
@@ -41,7 +41,10 @@ export function excludeFullySelectedFormFilters(
 
 /**
  * Generates the filters for a request URL based on the file manifest state.
- * If all terms in a facet are selected, the corresponding facet is excluded.
+ * Filters are returned based on the following conditions:
+ * - **form terms unselected**: No filters are returned.
+ * - **form terms partially selected**: All filters returned, including form filters.
+ * - **form terms fully selected**: Filters returned, excluding form filters.
  * @param state - File manifest state.
  * @returns filters for the request URL.
  */