jsdoc: Document RandomField class

obsidian-tasks-group · Oct 5, 2024 · abeb3cf · abeb3cf
1 parent 6bd5130
commit abeb3cf
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/Query/Filter/RandomField.ts b/src/Query/Filter/RandomField.ts
@@ -2,6 +2,11 @@ import type { Comparator } from '../Sort/Sorter';
 import type { Task } from '../../Task/Task';
 import { FilterInstructionsBasedField } from './FilterInstructionsBasedField';
 
+/**
+ * Sort tasks in a stable, random order.
+ *
+ * The sort order changes each day.
+ */
 export class RandomField extends FilterInstructionsBasedField {
     public fieldName(): string {
         return 'random';