From 1b742f417479c43d6f88f0457db203b33fbe45d4 Mon Sep 17 00:00:00 2001
From: Will Hopkins <willothyh@gmail.com>
Date: Thu, 28 Mar 2024 16:54:54 -0700
Subject: [PATCH] docs: document validator combinators

refactor!: soft-deprecate `compose` combinator
---
 docs/pages/docs/components/form.mdx | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/docs/pages/docs/components/form.mdx b/docs/pages/docs/components/form.mdx
index 0562162..fbecb66 100644
--- a/docs/pages/docs/components/form.mdx
+++ b/docs/pages/docs/components/form.mdx
@@ -38,14 +38,14 @@ n.form(
 
 #### on_submit
 
-<Property 
+<Property
   defaultValue="fn.ignore"
   types={['fun(is_valid: boolean): nil']}
 />
 
 #### submit_key
 
-<Property 
+<Property
   defaultValue="<C-CR>"
   types={['string[]', 'string']}
 />
@@ -63,4 +63,11 @@ Available validation functions:
 - `equals`
 - `contains`
 
+Available combinators:
+
+- `all`: ensures all validators pass
+- `any`: ensures at least one validator passes
+- `none`: ensures no validators pass
+- `compose` (deprecated, use `all`)
+