Docs review

Co-authored-by: Cem Aksoylar <[email protected]>
zmkfirmware · Dec 10, 2024 · ecb2005 · ecb2005
1 parent 77850b0
commit ecb2005
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/docs/docs/config/pointing.md b/docs/docs/config/pointing.md
@@ -45,11 +45,11 @@ Definition file: [zmk/app/dts/bindings/zmk,input-listener.yaml](https://github.c
 
 Additional properties can be set on child nodes, which allows changing the settings when certain layers are enabled:
 
-| Property           | Type          | Description                                                                                      |
-| ------------------ | ------------- | ------------------------------------------------------------------------------------------------ |
-| `layers`           | array         | List of layer indexes. This config will apply if any layer in the list is active.                |
-| `input-processors` | phandle-array | List of input processors (with parameters) to apply to input events                              |
-| `process-next`     | bool          | Whether to first apply the base input processors before the processors specific to this override |
+| Property           | Type          | Description                                                                                |
+| ------------------ | ------------- | ------------------------------------------------------------------------------------------ |
+| `layers`           | array         | List of layer indexes. This config will apply if any layer in the list is active.          |
+| `input-processors` | phandle-array | List of input processors (with parameters) to apply to input events                        |
+| `process-next`     | bool          | Whether to continue applying other input processors after this override if it takes effect |
 
 ## Input Split
 

diff --git a/docs/docs/keymaps/input-processors/usage.md b/docs/docs/keymaps/input-processors/usage.md
@@ -36,11 +36,11 @@ Additional overrides can be added that only apply when the associated layer is a
 
 :::note
 
-Overrides are processed in the order they are declared, from top to bottom, _not_ in any way tied to the layers specified in the `layers` property.
+Overrides are processed in the order they are declared, from top to bottom, followed by the base processors in the parent node. Their application order is _not_ in any way tied to the layers specified in the `layers` property.
 
 :::
 
-If you want to have later overrides, or your base processors applied _after_ your overrides, add the `inherit` property to your child node, e.g.:
+By default, the first-defined override node that matches the layer specification will apply, in which case and any other overrides or the base processors will be skipped. If you add the `process-next;` property to a child node, the other processors will continue to be checked and applied even if that node's layer filter matches.
 
 ```dts
 #include <input/processors.dtsi>
@@ -50,8 +50,8 @@ If you want to have later overrides, or your base processors applied _after_ you
 
     scroller {
         layers = <1>;
-        input-processors = <&zip_xy_to_scoll_mapper>;
-        inherit;
+        input-processors = <&zip_xy_to_scroll_mapper>;
+        process-next;
     };
 }
 ```