add doc for anyloop:clamp

cdqp · Jun 24, 2024 · 92e8271 · 92e8271
1 parent cb406b2
commit 92e8271
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/doc/devices/clamp.md b/doc/devices/clamp.md
@@ -0,0 +1,18 @@
+anyloop:clamp
+=============
+
+Types and units: `[T_BLOCK|T_VECTOR|T_MATRIX|T_BLOCK_UCHAR|T_MATRIX_UCHAR,
+U_ANY] -> [T_UNCHANGED, U_UNCHANGED]`.
+
+This device limits data in the pipeline to a minimum and maximum value.
+
+Parameters
+----------
+
+- `type` (string) (required)
+  - The type of data in the pipeline.
+- `min` (double) (optional)
+  - Minimum value to clamp to. Defaults to -1.0.
+- `max` (double) (optional)
+  - Maximum value to clamp to. Defaults to 1.0.
+
diff --git a/doc/devices/remove_piston.md b/doc/devices/remove_piston.md
@@ -1,5 +1,5 @@
-anyloop:remove_piston
-=====================
+anyloop:remove\_piston
+======================
 
 Types and units: `[T_MATRIX, U_ANY] -> [T_UNCHANGED, U_UNCHANGED]`.