Skip to content

Commit d87f185

Browse files
committed
docs(CHANGES): Document deprecated API changes
why: Changelog needs to document breaking changes. what: - Add APIs deprecated section listing all affected methods - Reference MIGRATION for full context - Note 0.50 deprecations remain as soft warnings
1 parent 137a267 commit d87f185

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CHANGES

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,29 @@ _Upcoming changes will be written here._
4444
- Fix incorrect return type annotations for `capture_pane()` and `display_message()` methods
4545
(changed from `str | list[str]` to `list[str]` - the methods always return a list).
4646

47+
#### APIs deprecated (#611)
48+
49+
Legacy API methods (deprecated in 0.16-0.33) now raise {exc}`~libtmux.exc.DeprecatedError` (hard error) instead of emitting {class}`DeprecationWarning`.
50+
51+
See {doc}`migration` for full context and examples.
52+
53+
| Deprecated API | Replacement | Deprecated | Raises | Note |
54+
|----------------|-------------|------------|--------|------|
55+
| `kill_server()` | {meth}`~libtmux.Server.kill` | 0.30.0 | 0.51.0 | Server |
56+
| `attach_session()`, `kill_session()` | {meth}`~libtmux.Session.attach`, {meth}`~libtmux.Session.kill` | 0.30.0 | 0.51.0 | Session |
57+
| `select_window()`, `kill_window()`, `split_window()` | {meth}`~libtmux.Window.select`, {meth}`~libtmux.Window.kill`, {meth}`~libtmux.Window.split` | 0.30.0 / 0.33.0 | 0.51.0 | Window |
58+
| `resize_pane()`, `select_pane()`, `split_window()` | {meth}`~libtmux.Pane.resize`, {meth}`~libtmux.Pane.select`, {meth}`~libtmux.Pane.split` | 0.28.0 / 0.30.0 / 0.33.0 | 0.51.0 | Pane |
59+
| `attached_window`, `attached_pane` | {attr}`~libtmux.Session.active_window`, {attr}`~libtmux.Session.active_pane` / {attr}`~libtmux.Window.active_pane` | 0.31.0 | 0.51.0 | Session/Window |
60+
| `list_*()`, `_list_*()`, `_update_*()`, `children`, `where()`, `find_where()`, `get_by_id()` | {attr}`~libtmux.Server.sessions` / {attr}`~libtmux.Session.windows` / {attr}`~libtmux.Window.panes` with {meth}`~libtmux.common.QueryList.filter` / {meth}`~libtmux.common.QueryList.get` | 0.16.0 / 0.17.0 | 0.51.0 | Query/filter helpers |
61+
| Dict-style access (`obj["key"]`, `obj.get(...)`) | Attribute access (e.g., {attr}`~libtmux.window.Window.window_name`) | 0.17.0 | 0.51.0 | All tmux objects |
62+
63+
The following deprecations from 0.50.0 continue to emit {class}`DeprecationWarning` (soft deprecation):
64+
65+
| Deprecated API | Replacement | Deprecated | Note |
66+
|----------------|-------------|------------|------|
67+
| `set_window_option()`, `show_window_option()`, `show_window_options()` | {meth}`~libtmux.window.Window.set_option`, {meth}`~libtmux.window.Window.show_option`, {meth}`~libtmux.window.Window.show_options` | 0.50.0 | Window |
68+
| `g` parameter on options/hooks methods | `global_` on {meth}`~libtmux.options.OptionsMixin.set_option`, {meth}`~libtmux.options.OptionsMixin.show_option`, {meth}`~libtmux.options.OptionsMixin.show_options` | 0.50.0 | Options & hooks |
69+
4770
## libtmux 0.50.0 (2025-11-30)
4871

4972
### Overview

0 commit comments

Comments
 (0)