Skip to content

Commit 1ec0c39

Browse files
committed
docs(CHANGES): Add release notes for options and hooks features
why: Document new OptionsMixin and HooksMixin features for 0.49.x release. what: - Add breaking changes for renamed Window option methods - Document OptionsMixin with set_option, show_option, show_options, unset_option - Document HooksMixin with set_hook, show_hook, unset_hook, set_hooks - Document new Window.set_option() arguments
1 parent 042b168 commit 1ec0c39

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

CHANGES

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,58 @@ $ uvx --from 'libtmux' --prerelease allow python
3434

3535
_Future release notes will be placed here_
3636

37+
### Breaking changes
38+
39+
#### Renamed commands
40+
41+
- Rename `Window.set_window_option()` to {meth}`Window.set_option()` (#516)
42+
43+
Deprecate `Window.set_window_option()`
44+
45+
- Rename `Window.show_window_option()` to {meth}`Window.show_option()` (#516)
46+
47+
Deprecate `Window.show_window_option()`
48+
49+
- Rename `Window.show_window_options()` to {meth}`Window.show_options()` (#516)
50+
51+
Deprecate `Window.show_window_options()`
52+
53+
### Improved options
54+
55+
- Expand option support to server, session, window, and pane
56+
- Enhance and streamline option support via {class}`options.OptionsMixin`.
57+
58+
- `set_option`
59+
- `show_option`
60+
- `show_options`
61+
- `unset_option`
62+
63+
- {meth}`Window.set_option()` (#516)
64+
65+
Add arguments:
66+
67+
- `format` -> `-F`
68+
- `unset` -> `-u`
69+
- `global` -> `-g`
70+
- `unset_panes` -> `-U`: Also unset other panes in windows
71+
- `prevent_overwrite`: `-o`
72+
- `suppress_warnings`: `-q`
73+
- `append`: `-a`
74+
75+
#### Hooks
76+
77+
Add {class}`hooks.HooksMixin` for managing tmux hooks programmatically:
78+
79+
- {meth}`~hooks.HooksMixin.set_hook` - Set a hook with optional index
80+
- {meth}`~hooks.HooksMixin.show_hook` - Show current value of a hook
81+
- {meth}`~hooks.HooksMixin.unset_hook` - Remove a hook
82+
83+
Bulk operations API for managing indexed hooks:
84+
85+
- {meth}`~hooks.HooksMixin.set_hooks` - Set multiple indexed hooks at once
86+
87+
HooksMixin is available on {class}`Server`, {class}`Session`, {class}`Window`, and {class}`Pane`.
88+
3789
## libtmux 0.48.0 (2025-11-28)
3890

3991
### Breaking Changes

0 commit comments

Comments
 (0)