Update from pinnacle-comp/pinnacle@2238017

Author: pinnacle-comp

classes/pinnacle.input.Bind.md

@@ -17,31 +17,31 @@ The modifiers that need to be pressed for this bind to trigger.
 
 ### bind_layer <Badge type="danger" text="nullable" />
 
-`bind_layer?`: <code>string</code>
+`bind_layer?`: <code>string?</code>
 
 The layer that this bind is assigned.
 
 ### group <Badge type="danger" text="nullable" />
 
-`group?`: <code>string</code>
+`group?`: <code>string?</code>
 
 The group to place this keybind in. Used for the keybind list.
 
 ### description <Badge type="danger" text="nullable" />
 
-`description?`: <code>string</code>
+`description?`: <code>string?</code>
 
 The description of this keybind. Used for the keybind list.
 
 ### quit <Badge type="danger" text="nullable" />
 
-`quit?`: <code>boolean</code>
+`quit?`: <code>boolean?</code>
 
 Sets this bind as a quit bind.
 
 ### reload_config <Badge type="danger" text="nullable" />
 
-`reload_config?`: <code>boolean</code>
+`reload_config?`: <code>boolean?</code>
 
 Sets this bind as a reload config bind.
 

classes/pinnacle.input.BindInfo.md

@@ -25,19 +25,19 @@ The bind's ignored modifiers.
 
 ### bind_layer <Badge type="danger" text="nullable" />
 
-`bind_layer?`: <code>string</code>
+`bind_layer?`: <code>string?</code>
 
 The bind's layer.
 
 ### group <Badge type="danger" text="nullable" />
 
-`group?`: <code>string</code>
+`group?`: <code>string?</code>
 
 The bind's group.
 
 ### description <Badge type="danger" text="nullable" />
 
-`description?`: <code>string</code>
+`description?`: <code>string?</code>
 
 The bind's description.
 

classes/pinnacle.input.BindInfoKind.md

@@ -11,13 +11,13 @@ The kind of a bind.
 
 ### key <Badge type="danger" text="nullable" />
 
-`key?`: <code>{ key_code: integer, xkb_name: string }</code>
+`key?`: <code>{ key_code: integer, xkb_name: string }?</code>
 
 This is a keybind.
 
 ### mouse <Badge type="danger" text="nullable" />
 
-`mouse?`: <code>{ button: <a href="/lua-reference/enums/pinnacle.input.MouseButton">pinnacle.input.MouseButton</a> }</code>
+`mouse?`: <code>{ button: <a href="/lua-reference/enums/pinnacle.input.MouseButton">pinnacle.input.MouseButton</a> }?</code>
 
 This is a mousebind.
 

classes/pinnacle.input.InputSignal.md

@@ -11,7 +11,7 @@ outline: [2, 3]
 
 ### device_added <Badge type="danger" text="nullable" />
 
-`device_added?`: <code>fun(device: <a href="/lua-reference/classes/pinnacle.input.libinput.DeviceHandle">pinnacle.input.libinput.DeviceHandle</a>)</code>
+`device_added?`: <code>fun(device: <a href="/lua-reference/classes/pinnacle.input.libinput.DeviceHandle">pinnacle.input.libinput.DeviceHandle</a>)?</code>
 
 A new input device was connected.
 

classes/pinnacle.input.Keybind.md

@@ -17,13 +17,13 @@ The key that will trigger this bind.
 
 ### on_press <Badge type="danger" text="nullable" />
 
-`on_press?`: <code>fun()</code>
+`on_press?`: <code>fun()?</code>
 
 An action that is run when the keybind is pressed.
 
 ### on_release <Badge type="danger" text="nullable" />
 
-`on_release?`: <code>fun()</code>
+`on_release?`: <code>fun()?</code>
 
 An action that is run when the keybind is released.
 

classes/pinnacle.input.Mousebind.md

@@ -17,13 +17,13 @@ The mouse button that will trigger this bind.
 
 ### on_press <Badge type="danger" text="nullable" />
 
-`on_press?`: <code>fun()</code>
+`on_press?`: <code>fun()?</code>
 
 An action that will be run when the mousebind is pressed.
 
 ### on_release <Badge type="danger" text="nullable" />
 
-`on_release?`: <code>fun()</code>
+`on_release?`: <code>fun()?</code>
 
 An action that will be run when the mousebind is released.
 

classes/pinnacle.input.XkbConfig.md

@@ -13,31 +13,31 @@ See `xkeyboard-config(7)` for more information.
 
 ### rules <Badge type="danger" text="nullable" />
 
-`rules?`: <code>string</code>
+`rules?`: <code>string?</code>
 
 Files of rules to be used for keyboard mapping composition.
 
 ### model <Badge type="danger" text="nullable" />
 
-`model?`: <code>string</code>
+`model?`: <code>string?</code>
 
 Name of the model of your keyboard type.
 
 ### layout <Badge type="danger" text="nullable" />
 
-`layout?`: <code>string</code>
+`layout?`: <code>string?</code>
 
 Layout(s) you intend to use.
 
 ### variant <Badge type="danger" text="nullable" />
 
-`variant?`: <code>string</code>
+`variant?`: <code>string?</code>
 
 Variant(s) of the layout you intend to use.
 
 ### options <Badge type="danger" text="nullable" />
 
-`options?`: <code>string</code>
+`options?`: <code>string?</code>
 
 Extra xkb configuration options.
 

classes/pinnacle.input.md

@@ -28,7 +28,7 @@ Keycodes for every key.
 
 ### <Badge type="function" text="function" /> keybind
 
-<div class="language-lua"><pre><code>function pinnacle.input.keybind(mods: <a href="/lua-reference/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[], key: <a href="/lua-reference/enums/pinnacle.input.Key">pinnacle.input.Key</a> | string, on_press: fun(), bind_info?: { group: string, description: string })</code></pre></div>
+<div class="language-lua"><pre><code>function pinnacle.input.keybind(mods: <a href="/lua-reference/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[], key: <a href="/lua-reference/enums/pinnacle.input.Key">pinnacle.input.Key</a> | string, on_press: fun(), bind_info?: { group?: string?, description?: string? }?)</code></pre></div>
 
 Sets a keybind.
 
@@ -76,7 +76,7 @@ end)
 `mods`: <code><a href="/lua-reference/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[]</code> - The modifiers that need to be held down for the bind to trigger<br>
 `key`: <code><a href="/lua-reference/enums/pinnacle.input.Key">pinnacle.input.Key</a> | string</code> - The key used to trigger the bind<br>
 `on_press`: <code>fun()</code> - The function to run when the bind is triggered<br>
-`bind_info?`: <code>{ group: string, description: string }</code> - An optional group and description that is displayed in the bind overlay.
+`bind_info?`: <code>{ group?: string?, description?: string? }?</code> - An optional group and description that is displayed in the bind overlay.
 
 
 
@@ -85,7 +85,7 @@ end)
 
 ### <Badge type="function" text="function" /> mousebind
 
-<div class="language-lua"><pre><code>function pinnacle.input.mousebind(mods: <a href="/lua-reference/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[], button: <a href="/lua-reference/enums/pinnacle.input.MouseButton">pinnacle.input.MouseButton</a>, on_press: fun(), bind_info?: { group: string, description: string })</code></pre></div>
+<div class="language-lua"><pre><code>function pinnacle.input.mousebind(mods: <a href="/lua-reference/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[], button: <a href="/lua-reference/enums/pinnacle.input.MouseButton">pinnacle.input.MouseButton</a>, on_press: fun(), bind_info?: { group?: string?, description?: string? }?)</code></pre></div>
 
 Sets a mousebind.
 
@@ -125,7 +125,7 @@ end)
 `mods`: <code><a href="/lua-reference/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[]</code> - The modifiers that need to be held down for the bind to trigger<br>
 `button`: <code><a href="/lua-reference/enums/pinnacle.input.MouseButton">pinnacle.input.MouseButton</a></code> - The mouse button used to trigger the bind<br>
 `on_press`: <code>fun()</code> - The function to run when the bind is triggered<br>
-`bind_info?`: <code>{ group: string, description: string }</code> - An optional group and description that will be displayed in the bind overlay.
+`bind_info?`: <code>{ group?: string?, description?: string? }?</code> - An optional group and description that will be displayed in the bind overlay.
 
 
 
@@ -134,14 +134,14 @@ end)
 
 ### <Badge type="function" text="function" /> enter_bind_layer
 
-<div class="language-lua"><pre><code>function pinnacle.input.enter_bind_layer(layer?: string)</code></pre></div>
+<div class="language-lua"><pre><code>function pinnacle.input.enter_bind_layer(layer?: string?)</code></pre></div>
 
 Enters the bind layer `layer`, or the default layer if `layer` is nil.
 
 
 #### Parameters
 
-`layer?`: <code>string</code> - The bind layer.
+`layer?`: <code>string?</code> - The bind layer.
 
 
 

classes/pinnacle.layout.LayoutNode.md

@@ -11,37 +11,37 @@ outline: [2, 3]
 
 ### label <Badge type="danger" text="nullable" />
 
-`label?`: <code>string</code>
+`label?`: <code>string?</code>
 
 A label that helps Pinnacle decide how to diff layout trees.
 
 ### traversal_index <Badge type="danger" text="nullable" />
 
-`traversal_index?`: <code>integer</code>
+`traversal_index?`: <code>integer?</code>
 
 An index that determines how Pinnacle traverses a layout tree.
 
 ### traversal_overrides <Badge type="danger" text="nullable" />
 
-`traversal_overrides?`: <code>table&lt;integer, integer[]></code>
+`traversal_overrides?`: <code>table&lt;integer, integer[]>?</code>
 
 A set of indices per window index that changes how that window is assigned a geometry.
 
 ### layout_dir <Badge type="danger" text="nullable" />
 
-`layout_dir?`: <code><a href="/lua-reference/aliases/pinnacle.layout.LayoutDir">pinnacle.layout.LayoutDir</a></code>
+`layout_dir?`: <code><a href="/lua-reference/aliases/pinnacle.layout.LayoutDir">pinnacle.layout.LayoutDir</a>?</code>
 
 The direction that child nodes are laid out.
 
 ### gaps <Badge type="danger" text="nullable" />
 
-`gaps?`: <code>number | <a href="/lua-reference/aliases/pinnacle.layout.Gaps">pinnacle.layout.Gaps</a></code>
+`gaps?`: <code>number | <a href="/lua-reference/aliases/pinnacle.layout.Gaps">pinnacle.layout.Gaps</a>?</code>
 
 The gaps the node applies around its children nodes.
 
 ### size_proportion <Badge type="danger" text="nullable" />
 
-`size_proportion?`: <code>number</code>
+`size_proportion?`: <code>number?</code>
 
 The proportion the node takes up relative to its siblings.
 

classes/pinnacle.layout.LayoutRequester.md

@@ -20,14 +20,14 @@ An object that allows you to forcibly request layouts.
 
 ### <Badge type="method" text="method" /> request_layout
 
-<div class="language-lua"><pre><code>function pinnacle.layout.LayoutRequester:request_layout(output?: <a href="/lua-reference/classes/pinnacle.output.OutputHandle">pinnacle.output.OutputHandle</a>)</code></pre></div>
+<div class="language-lua"><pre><code>function pinnacle.layout.LayoutRequester:request_layout(output?: <a href="/lua-reference/classes/pinnacle.output.OutputHandle">pinnacle.output.OutputHandle</a>?)</code></pre></div>
 
 Causes the compositor to emit a layout request.
 
 
 #### Parameters
 
-`output?`: <code><a href="/lua-reference/classes/pinnacle.output.OutputHandle">pinnacle.output.OutputHandle</a></code> - The output to layout, or `nil` for the focused output.
+`output?`: <code><a href="/lua-reference/classes/pinnacle.output.OutputHandle">pinnacle.output.OutputHandle</a>?</code> - The output to layout, or `nil` for the focused output.