From abeb3cf14ada50b1463157dc22337e33c4f5868a Mon Sep 17 00:00:00 2001
From: Clare Macrae <github@cfmacrae.fastmail.co.uk>
Date: Sat, 5 Oct 2024 21:14:15 +0100
Subject: [PATCH] jsdoc: Document RandomField class

---
 src/Query/Filter/RandomField.ts | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/Query/Filter/RandomField.ts b/src/Query/Filter/RandomField.ts
index 81240c7972..860bb1e404 100644
--- 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';