Skip to content

Commit fa8766f

Browse files
committed
docs(CHANGES): Note updates for options
1 parent 911cbe0 commit fa8766f

File tree

1 file changed

+33
-7
lines changed

1 file changed

+33
-7
lines changed

CHANGES

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,41 @@ $ pip install --user --upgrade --pre libtmux
1515

1616
<!-- To maintainers and contributors: Please add notes for the forthcoming version above -->
1717

18-
### Development
18+
### Renamed commands
19+
20+
- Renamed `Window.set_window_option()` to {meth}`Window.set_option()` (#516)
21+
22+
Deprecated `Window.set_window_option()`
23+
24+
- Renamed `Window.show_window_option()` to {meth}`Window.show_option()` (#516)
25+
26+
Deprecated `Window.show_window_option()`
27+
28+
- Renamed `Window.show_window_options()` to {meth}`Window.show_options()` (#516)
1929

20-
#### chore: Implement PEP 563 deferred annotation resolution (#555)
30+
Deprecated `Window.show_window_options()`
2131

22-
- Add `from __future__ import annotations` to defer annotation resolution and reduce unnecessary runtime computations during type checking.
23-
- Enable Ruff checks for PEP-compliant annotations:
24-
- [non-pep585-annotation (UP006)](https://docs.astral.sh/ruff/rules/non-pep585-annotation/)
25-
- [non-pep604-annotation (UP007)](https://docs.astral.sh/ruff/rules/non-pep604-annotation/)
32+
### Improved options
2633

27-
For more details on PEP 563, see: https://peps.python.org/pep-0563/
34+
- Option support expanded to server, session, window, and pane
35+
- Option support enhanced and streamlined via {class}`options.OptionsMixin`.
36+
37+
- `set_option`
38+
- `show_option`
39+
- `show_options`
40+
- `unset_option`
41+
42+
- {meth}`Window.set_option()` (#516)
43+
44+
Added arguments:
45+
46+
- `format` -> `-F`
47+
- `unset` -> `-u`
48+
- `global` -> `-g`
49+
- `unset_panes` -> `-U`: Also unset other panse in windows
50+
- `prevent_overwrite`: `-o`
51+
- `suppress_warnings`: `-q`
52+
- `append`: `-a`
2853

2954
## libtmux 0.40.1 (2024-12-24)
3055

@@ -50,6 +75,7 @@ _Maintenance only, no bug fixes or new features_
5075
```sh
5176
ruff check --select ALL . --fix --unsafe-fixes --preview --show-fixes; ruff format .
5277
```
78+
5379
- Tests: Stability fixes for legacy `test_select_pane` test (#552)
5480

5581
## libtmux 0.39.0 (2024-11-26)

0 commit comments

Comments
 (0)