From 031a19741fa8268401e53e770845bc165de0b723 Mon Sep 17 00:00:00 2001
From: zkldi <20380519+zkldi@users.noreply.github.com>
Date: Fri, 16 Dec 2022 08:30:20 +0000
Subject: [PATCH] docs: warn about garbage

---
 client/src/util/ztable/search.ts | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/client/src/util/ztable/search.ts b/client/src/util/ztable/search.ts
index 71bf0824b..e6965b6f0 100644
--- a/client/src/util/ztable/search.ts
+++ b/client/src/util/ztable/search.ts
@@ -1,6 +1,15 @@
 import { SEARCH_DIRECTIVES } from "util/constants/search-directives";
 import { ZTableSearchFn } from "components/util/table/useZTable";
 
+// This file sucks. Don't even attempt to understand it. Luckily, it works and
+// never needs any extending, but should you want to change something here,
+// it would genuinely be faster to just completely rewrite it.
+// This is a parser that handles things like
+// title:"FREEDOM DIVE" level:>12
+// etc.
+// This was written before I knew anything about how to implement a lexer or parser.
+// Apologies.
+
 export interface SearchDirective {
 	key: string;
 	option: string | null;