feat: jsdoc (#287)

DataBiosphere · Dec 4, 2024 · fff7bb9 · fff7bb9
1 parent 9dc13fe
commit fff7bb9
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/src/providers/fileManifestState/utils.ts b/src/providers/fileManifestState/utils.ts
@@ -22,9 +22,11 @@ export function areAllFormFacetsSelected(state: FileManifestState): boolean {
 }
 
 /**
- * Determines if all form facet terms are fully selected.
+ * Checks whether all form facets have all their terms fully selected.
+ * - **true**: All form facets have all their terms selected.
+ * - **false**: At least one form facet has an unselected term.
  * @param state - File manifest state.
- * @returns true if all form facet terms are fully selected.
+ * @returns true if all form facets have all their terms selected.
  */
 export function areAllFormFiltersSelected(state: FileManifestState): boolean {
   const { filesFacets, filters, selectedFormFacetNames } = state;